|
| 1 | +## Contributing |
| 2 | + |
| 3 | +[fork]: /fork |
| 4 | + |
| 5 | +[pr]: /compare |
| 6 | + |
| 7 | +[code-of-conduct]: CODE_OF_CONDUCT.md |
| 8 | + |
| 9 | +[templates]: templates |
| 10 | + |
| 11 | +Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. |
| 12 | + |
| 13 | +Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in |
| 14 | +this project you agree to abide by its terms. |
| 15 | + |
| 16 | +## Issues and PRs |
| 17 | + |
| 18 | +If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all |
| 19 | +and any contributions. If you have questions, too, we'd love to hear them. |
| 20 | + |
| 21 | +We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look |
| 22 | +at the links below if you're not sure how to open a PR. |
| 23 | + |
| 24 | +## Submitting a pull request |
| 25 | + |
| 26 | +1. [Fork][fork] and clone the repository. |
| 27 | +2. Create a new branch: `git checkout -b my-branch-name`. |
| 28 | +3. Make your changes, fix bugs, add modules, plugins or commands and perform tests. |
| 29 | +4. Push to your fork and [submit a pull request][pr]. |
| 30 | +5. Pat your self on the back and wait for your pull request to be reviewed and merged. |
| 31 | + |
| 32 | +Here are a few things you can do that will increase the likelihood of your pull request being accepted: |
| 33 | + |
| 34 | +- Follow the standard of [templates][templates]. |
| 35 | +- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent |
| 36 | + upon each other, consider submitting them as separate pull requests. |
| 37 | +- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). |
| 38 | + |
| 39 | +Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you. |
| 40 | + |
| 41 | +## Resources |
| 42 | + |
| 43 | +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) |
| 44 | +- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) |
| 45 | +- [GitHub Help](https://help.github.com) |
0 commit comments