From: salimfadhley <sal@stodge.org>
Date: Thu, 17 Oct 2013 00:28:43 +0000 (+0100)
Subject: add a new doc
X-Git-Tag: v0.2.23~71
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=48d686840bc0c6b3b6b5abc5ab5ad5620f33f8de;p=tools%2Fpython-jenkinsapi.git

add a new doc
---

diff --git a/doc/source/rules_for_contributors.rst b/doc/source/rules_for_contributors.rst
new file mode 100644
index 0000000..ce49336
--- /dev/null
+++ b/doc/source/rules_for_contributors.rst
@@ -0,0 +1,30 @@
+Rules for Contributors
+======================
+
+The JenkinsAPI project welcomes contributions via GitHub. Please bear in mind the following guidelines when preparing your pull-request.
+
+Python compatibility
+--------------------
+
+The project currently targets Python 2.6 and Python 2.7. Support for Python 3.x will be introduced soon. Please do not add any features which
+will break our supported Python 2.x versions or make it harder for us to migrate to Python 3.x
+
+Test Driven Development
+-----------------------
+
+Please do not submit pull requests without tests. That's really important. Our project is all about test-driven development. It would be
+embarrasing if our project failed because of a lack of tests!
+
+You might want to follow a typical test driven development cycle: http://en.wikipedia.org/wiki/Test-driven_development
+
+Put simply: Write your tests first and only implement features required to make your tests pass. Do not let your implementation get ahead of your tests.
+
+Check the CI status before comitting
+------------------------------------
+
+We have a Travis CI account - please verify that your branch works before making a pull request.
+
+Any problems?
+-------------
+
+If you are stuck on something, please post to the issue tracker. Do not contact the developers directly.