| 1 | # Contributing to `dugite`
|
| 2 |
|
| 3 | [fork]: https://github.com/desktop/dugite/fork
|
| 4 | [pr]: https://github.com/desktop/dugite/compare
|
| 5 | [code-of-conduct]: CODE_OF_CONDUCT.md
|
| 6 | [documentation]: docs/README.md
|
| 7 |
|
| 8 | Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
|
| 9 |
|
| 10 | Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
|
| 11 |
|
| 12 | ## Submitting a pull request
|
| 13 |
|
| 14 | 0. [Fork][fork] and clone the repository
|
| 15 | 0. Look over the [documentation][documentation] on how and where to make changes
|
| 16 | 0. Create a new branch: `git checkout -b my-branch-name`
|
| 17 | 0. Make your change
|
| 18 | 0. Push to your fork and [submit a pull request][pr]
|
| 19 | 0. Pat your self on the back and wait for your pull request to be reviewed and merged.
|
| 20 |
|
| 21 | Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
| 22 |
|
| 23 | - 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.
|
| 24 | - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
| 25 | - In your pull request description, provide as much detail as possible. This context helps the reviewer to understand the motivation for and impact of the change.
|
| 26 |
|
| 27 | ## Resources
|
| 28 |
|
| 29 | - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
| 30 | - [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
|
| 31 | - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
| 32 | - [GitHub Help](https://help.github.com)
|