-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from github/contributing
Add CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
## Contributing | ||
|
||
[fork]: https://github.com/github/sigstore-go/fork | ||
[pr]: https://github.com/github/sigstore-go/compare | ||
[style]: https://github.com/github/sigstore-go/blob/main/.golangci.yaml | ||
[code-of-conduct]: CODE_OF_CONDUCT.md | ||
|
||
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
||
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt). | ||
|
||
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
||
## Prerequisites for running and testing code | ||
|
||
These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process. | ||
|
||
1. install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go) | ||
1. [install golangci-lint](https://golangci-lint.run/usage/install/#local-installation) | ||
|
||
## Submitting a pull request | ||
|
||
1. [Fork][fork] and clone the repository | ||
1. Make sure the tests pass on your machine: `go test -v ./...` | ||
1. Make sure linter passes on your machine: `golangci-lint run` | ||
1. Create a new branch: `git checkout -b my-branch-name` | ||
1. Make your change, add tests, and make sure the tests and linter still pass | ||
1. Push to your fork and [submit a pull request][pr] | ||
1. Pat yourself on the back and wait for your pull request to be reviewed and merged. | ||
|
||
Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
||
- Follow the [style guide][style]. | ||
- Write tests. | ||
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
## Resources | ||
|
||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) | ||
- [GitHub Help](https://help.github.com) |