summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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