diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2016-06-13 10:13:18 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2016-06-13 10:13:18 +0200 |
| commit | 17020d8ac806faf6ffa178587a97625589ba21eb (patch) | |
| tree | 00b5a27c0f14dc742746f636233e4edb7c288b1c /CONTRIBUTING.md | |
| parent | 15ee5a505b43741cdb7c79f41ebfa3d881910a6c (diff) | |
| download | gitpython-17020d8ac806faf6ffa178587a97625589ba21eb.tar.gz | |
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.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
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 + |