summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2016-06-13 10:13:18 +0200
committerSebastian Thiel <byronimo@gmail.com>2016-06-13 10:13:18 +0200
commit17020d8ac806faf6ffa178587a97625589ba21eb (patch)
tree00b5a27c0f14dc742746f636233e4edb7c288b1c
parent15ee5a505b43741cdb7c79f41ebfa3d881910a6c (diff)
downloadgitpython-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.
-rw-r--r--CONTRIBUTING.md6
-rw-r--r--README.md7
2 files changed, 9 insertions, 4 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
+
diff --git a/README.md b/README.md
index b3c5c947..7daa8317 100644
--- a/README.md
+++ b/README.md
@@ -45,11 +45,9 @@ Then run:
tox
-### SOURCE
+### Contributions
-GitPython's git repo is available on GitHub, which can be browsed at [github](https://github.com/gitpython-developers/GitPython) and cloned like that:
-
- git clone https://github.com/gitpython-developers/GitPython
+Please have a look at the [contributions file][contributing].
### Live Coding
@@ -100,3 +98,4 @@ Now that there seems to be a massive user base, this should be motivation enough
[twitch-channel]: http://www.twitch.tv/byronimo/profile
[youtube-playlist]: https://www.youtube.com/playlist?list=PLMHbQxe1e9MnoEcLhn6Yhv5KAvpWkJbL0
+[contributing]: https://github.com/gitpython-developers/GitPython/blob/master/README.md \ No newline at end of file