Skip to content

Commit

Permalink
Updated contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasdille committed Nov 8, 2023
1 parent 324d03a commit 18497f6
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 1 deletion.
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <[email protected]>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
52 changes: 51 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,49 @@
## How to contribute
# Contributing to uniget

Thank you for considering contributing to uniget! We welcome any contributions, whether it's bug fixes, new features, or improvements to the existing codebase.

## Contribution Prerequisites

Make sure that you have [Docker]() and [buildx]() installed. You can use a locally installed [Go]() but the containerized build environment enables you to use the same tooling as in CI.

## Sending a Pull Request

1. Create an issue in the repository outlining the fix or feature
1. Fork the repository to your own GitHub account and clone it locally
1. Complete and test the change
1. Create a concise commit message and reference the issue(s) and pull request(s) adressed
1. (Optionally) Sign off your commit
1. Ensure that CI passes. If it fails, fix the failures
1. Every pull request requires a review

The following steps describe the build, linting and testing processes:

### Building Cosign

To build locally, run this command:

```shell
docker buildx bake binary
```

### Running tests

To run the tests, execute the following commands:

```shell
docker buildx bake lint
docker buildx bake vet
docker buildx bake gosec
docker buildx bake test
```

**Make sure all tests pass** without any failures or errors.

### Sign DCO

Make sure to sign the [Developer Certificate of Origin](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff).

## What to contribute

### Did one of the installed tools misbehave?

Expand Down Expand Up @@ -37,3 +82,8 @@
* **Ensure the question was not already asked** by searching on GitHub under [Discussions](https://github.com/uniget-org/cli/discussions)

* If you're unable to find an open question addressing the topics, [open a new one](https://github.com/uniget-org/cli/discussions)

## Code of Conduct

Sigstore adheres to and enforces the [Contributor Covenant](http://contributor-covenant.org/version/1/4/) Code of Conduct.
Please take a moment to read the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) document.

0 comments on commit 18497f6

Please sign in to comment.