From bd0fa882f6c8fd2ab907e9f5988f32f466d75bdf Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Wed, 18 Aug 2021 09:09:29 +0800 Subject: overhaul CONTIRIBUTING.md Thanks to #1322 --- CONTRIBUTING.md | 15 +++++++-------- 1 file 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. -- cgit v1.2.1