|
| 1 | +## Contributing |
| 2 | + |
| 3 | +[code-of-conduct]: CODE_OF_CONDUCT.md |
| 4 | +[commit-guidance]: https://github.blog/2022-06-30-write-better-commits-build-better-projects/ |
| 5 | +[compare]: https://github.com/github/git-bundle-server/compare |
| 6 | +[contributions-under-license]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license |
| 7 | +[github-help]: https://help.github.com |
| 8 | +[license]: LICENSE |
| 9 | +[open-source-contributions]: https://opensource.guide/how-to-contribute/ |
| 10 | +[pr-guidance]: https://help.github.com/articles/about-pull-requests/ |
| 11 | +[readme]: README.md |
| 12 | + |
| 13 | +Hi there! We're thrilled that you'd like to contribute to the `git-bundle-server` |
| 14 | +project. Your work is extremely appreciated :star:. |
| 15 | + |
| 16 | +Contributions to this project are [released][contributions-under-license] to the public |
| 17 | +under the [project's open source license][license]. |
| 18 | + |
| 19 | +Please note that this project is released with a [Contributor Code of |
| 20 | +Conduct][code-of-conduct]. By participating in this project you agree to abide |
| 21 | +by its terms. |
| 22 | + |
| 23 | +## Prerequisites for running and testing code |
| 24 | + |
| 25 | +Check out the project's [`README`][README] for thorough guidance on how |
| 26 | +to hit the ground running :dash:. |
| 27 | + |
| 28 | +## Submitting a pull request |
| 29 | + |
| 30 | +1. Clone the repository. |
| 31 | +0. Reference the project's [`README`][README] to build, test, and lint. |
| 32 | +0. Create a new branch: `git checkout -b <my-branch-name>` |
| 33 | +0. Do some awesome work :sparkles:. |
| 34 | +0. Add tests and make sure the tests and linter still pass. |
| 35 | +0. Push your changes and [submit a pull request][compare]. |
| 36 | +0. Pat yourself on the back and wait for your pull request to be reviewed |
| 37 | +and merged. |
| 38 | + |
| 39 | +Here are a few things you can do that will increase the likelihood of your pull |
| 40 | +request being accepted: |
| 41 | + |
| 42 | +- Write tests. |
| 43 | +- Keep your change as focused as possible. If there are multiple changes you |
| 44 | +would like to make that are not dependent upon each other, consider submitting |
| 45 | +them as separate pull requests. |
| 46 | +- Write a [good commit message][commit-guidance]. |
| 47 | + |
| 48 | +## Resources |
| 49 | + |
| 50 | +- [How to Contribute to Open Source][open-source-contributions] |
| 51 | +- [Using Pull Requests][pr-guidance] |
| 52 | +- [GitHub Help][github-help] |
0 commit comments