diff options
| author | Sebastian Thiel <sebastian.thiel@icloud.com> | 2020-09-03 10:21:40 +0800 |
|---|---|---|
| committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2020-09-03 10:21:40 +0800 |
| commit | fb7fd31955aaba8becbdffb75dab2963d5f5ad8c (patch) | |
| tree | 1c62783effe998f6b3fa8e6c34d14db3f3da1d59 /CONTRIBUTING.md | |
| parent | 8f9840b9220d57b737ca98343e7a756552739168 (diff) | |
| download | gitpython-fb7fd31955aaba8becbdffb75dab2963d5f5ad8c.tar.gz | |
update contribution guidelines to be a little less concise and more polite
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0347afcb..4217cbaf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,10 @@ ### How to contribute -* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub -* For setting up the environment to run the self tests, look at `.travis.yml`. -* Add yourself to AUTHORS and write your patch. **Write a test that fails unless your patch is present.** -* Initiate a pull request +The following is a short step-by-step rundown of what one typically would do to contribute. + +* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub. +* For setting up the environment to run the self tests, please look at `.travis.yml`. +* Please try to **write a test that fails unless the contribution is present.** +* Feel free to add yourself to AUTHORS file. +* Create a pull request. |