More docs, CI system info and a check-xml to permit easy CI integration.

1 files changed, 32 insertions, 0 deletions

diff --git a/doc/DEVELOPERS.txt b/doc/DEVELOPERS.txt
new file mode 100644
index 0000000..fc090b6
--- /dev/null
+++ b/doc/DEVELOPERS.txt
@@ -0,0 +1,32 @@
+Development guidelines for Test Repository
+++++++++++++++++++++++++++++++++++++++++++
+
+Coding style
+~~~~~~~~~~~~
+
+PEP-8 please. We don't enforce a particular style, but being reasonably 
+consistent aids readability.
+
+Copyrights and licensing
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Code committed to Test Repository must be licensed under the BSD + Apache-2.0
+licences that Test Repository offers its users. Copyright assignment is not
+required. Please see COPYING for details about how to make a license grant in
+a given source file. Lastly, all copyright holders need to add their name
+to the master list in COPYING the first time they make a change in a given
+calendar year.
+
+Testing and QA
+~~~~~~~~~~~~~~
+
+For Test repository please add tests where possible. There is no requirement
+for one test per change (because somethings are much harder to automatically
+test than the benfit from such tests). Fast tests are preferred to slow tests,
+and understandable tests to fast tests.
+
+http://build.robertcollins.net/ has a job testing every commit made to trunk
+of Test Repository, and there is no automated test-before-merge process at the
+moment. The quid pro quo for committers is that they should check that the
+automated job found their change acceptable after merging it, and either roll
+it back or fix it immediately. A broken trunk is not acceptable!