Skip to content

Commit 17020d8

Browse files
committed
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.
1 parent 15ee5a5 commit 17020d8

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

Diff for: CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
### How to contribute
2+
3+
* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on github
4+
* Add yourself to AUTHORS.md and write your patch. **Write a test that fails unless your patch is present.**
5+
* Initiate a pull request
6+

Diff for: README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,9 @@ Then run:
4545

4646
tox
4747

48-
### SOURCE
48+
### Contributions
4949

50-
GitPython's git repo is available on GitHub, which can be browsed at [github](https://github.com/gitpython-developers/GitPython) and cloned like that:
51-
52-
git clone https://github.com/gitpython-developers/GitPython
50+
Please have a look at the [contributions file][contributing].
5351

5452
### Live Coding
5553

@@ -100,3 +98,4 @@ Now that there seems to be a massive user base, this should be motivation enough
10098

10199
[twitch-channel]: http://www.twitch.tv/byronimo/profile
102100
[youtube-playlist]: https://www.youtube.com/playlist?list=PLMHbQxe1e9MnoEcLhn6Yhv5KAvpWkJbL0
101+
[contributing]: https://github.com/gitpython-developers/GitPython/blob/master/README.md

0 commit comments

Comments
 (0)