summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2010-08-15 21:01:23 +1200
committerRobert Collins <robertc@robertcollins.net>2010-08-15 21:01:23 +1200
commitae179f1966ef3aaf6ec49cc819bffb7f4b7fd757 (patch)
tree235184e648b09dd0b296616c39a76e717dba60de /HACKING
downloadfixtures-git-ae179f1966ef3aaf6ec49cc819bffb7f4b7fd757.tar.gz
First draft - 0.1.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING37
1 files changed, 37 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..829dc42
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,37 @@
+Contributing to fixtures
+========================
+
+Code access
++++++++++++
+
+Branch from the trunk (all patches should be for trunk unless there are
+exceptional circumstances)::
+
+ bzr branch lp:python-fixtures path-to-new-local-branch
+
+Publish your branches whereever you like, I encourage Launchpad hosting though,
+as it can notify the community of new fixtures branches::
+
+ bzr push lp:~YOURUSERNAME/python-fixtures/YOURBRANCHNAME
+
+Copyright
++++++++++
+
+Fixtures is Copyright (C) 2010 Robert Collins. I'd like to be able to
+offer it up for stdlib inclusion once it has proved itself, so am asking for
+copyright assignment to me - or for your contributions to be under the BSD and
+Apache-2.0 licences that Fixtures is under (which permit inclusion in Python).
+
+Coding standards
+++++++++++++++++
+
+PEP-8 coding style please, though perfection isn't needed. Make sure that 'make
+check' passes before sending in a patch.
+
+Code arrangement
+++++++++++++++++
+
+The ``fixtures`` module should simply import classes and functions from
+more specific modules, rather than becoming large and bloated itself. For
+instance, TestWithFixtures lives in fixtures.testcase, and is imported in
+the fixtures __init__.py.