From 17020d8ac806faf6ffa178587a97625589ba21eb Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 13 Jun 2016 10:13:18 +0200 Subject: doc(README): add basic contribution guidelines The main point is that from now on, tests are required to add new features. If the fix is minor enough, not having a test is probably alright. That distinction is not represented in the contribution guide as more tests are better - people should prefer to have a test whenever they contribute anything. My motivation to finally do this is the sad realization that I grow too unconfident about the quality of some contributions without having tests that proof they are valid. It's not enough to not break anything that exists, as the current test-suite is certainly not perfect either. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..421e59e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +### How to contribute + +* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on github +* Add yourself to AUTHORS.md and write your patch. **Write a test that fails unless your patch is present.** +* Initiate a pull request + -- cgit v1.2.1