diff options
author | Sebastian Thiel <sebastian.thiel@icloud.com> | 2021-08-18 09:09:29 +0800 |
---|---|---|
committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2021-08-18 09:09:29 +0800 |
commit | bd0fa882f6c8fd2ab907e9f5988f32f466d75bdf (patch) | |
tree | 196d0964496189fae59075f234f8fb75da244d01 /CONTRIBUTING.md | |
parent | 5b3669e24a8ce7f3f482de86fcf95620db643467 (diff) | |
download | gitpython-bd0fa882f6c8fd2ab907e9f5988f32f466d75bdf.tar.gz |
overhaul CONTIRIBUTING.md
Thanks to #1322
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f685e7e7..56af0df2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,10 @@ -### How to contribute +# How to contribute 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.** -* Try to avoid massive commits and prefer to take small steps, with one commit for each. -* Feel free to add yourself to AUTHORS file. -* Create a pull request. - +- [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub. +- For setting up the environment to run the self tests, please run `init-tests-after-clone.sh`. +- Please try to **write a test that fails unless the contribution is present.** +- Try to avoid massive commits and prefer to take small steps, with one commit for each. +- Feel free to add yourself to AUTHORS file. +- Create a pull request. |