summaryrefslogtreecommitdiff
path: root/HACKING
blob: 6ef1c8dcca75ecc25fee09263549dad77548359b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
Contributing to fixtures
========================

Code access
+++++++++++

Branch from the trunk (all patches should be for trunk unless there are
exceptional circumstances)::

  git clone https://github.com/testing-cabal/fixtures path-to-new-local-repo

Publish your branches wherever you like and submit PR's on github.

Copyright
+++++++++

Fixtures is Copyright (C) 2010-2014 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.

Releasing
+++++++++

1. Add a version to NEWS.

1. commit, tag::

    git commit -am "Release X.Y.Z"
    git tag -m "Release X.Y.Z" X.Y.Z
    git push --tags origin master:master

1. Upload to pypi, signed.

1. Close bugs.

1. Rename the next milestone, release it, and make a new one.