~python-fixtures/debian/sid/python-fixtures/sid

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Robert Collins
  • Date: 2010-08-15 09:01:23 UTC
  • Revision ID: robertc@robertcollins.net-20100815090123-t9r746rqxnp73o66
First draft - 0.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Contributing to fixtures
 
2
========================
 
3
 
 
4
Code access
 
5
+++++++++++
 
6
 
 
7
Branch from the trunk (all patches should be for trunk unless there are
 
8
exceptional circumstances)::
 
9
 
 
10
  bzr branch lp:python-fixtures path-to-new-local-branch
 
11
 
 
12
Publish your branches whereever you like, I encourage Launchpad hosting though,
 
13
as it can notify the community of new fixtures branches::
 
14
 
 
15
  bzr push lp:~YOURUSERNAME/python-fixtures/YOURBRANCHNAME
 
16
 
 
17
Copyright
 
18
+++++++++
 
19
 
 
20
Fixtures is Copyright (C) 2010 Robert Collins. I'd like to be able to
 
21
offer it up for stdlib inclusion once it has proved itself, so am asking for
 
22
copyright assignment to me - or for your contributions to be under the BSD and
 
23
Apache-2.0 licences that Fixtures is under (which permit inclusion in Python).
 
24
 
 
25
Coding standards
 
26
++++++++++++++++
 
27
 
 
28
PEP-8 coding style please, though perfection isn't needed. Make sure that 'make
 
29
check' passes before sending in a patch.
 
30
 
 
31
Code arrangement
 
32
++++++++++++++++
 
33
 
 
34
The ``fixtures`` module should simply import classes and functions from
 
35
more specific modules, rather than becoming large and bloated itself. For
 
36
instance, TestWithFixtures lives in fixtures.testcase, and is imported in
 
37
the fixtures __init__.py.