From fb7fd31955aaba8becbdffb75dab2963d5f5ad8c Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 3 Sep 2020 10:21:40 +0800 Subject: update contribution guidelines to be a little less concise and more polite --- CONTRIBUTING.md | 11 +++++++---- 1 file 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. -- cgit v1.2.1