← Back to branch summary

~benji/testtools/modernize-tsfr

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Jonathan Lange
  • Date: 2008-10-04 03:51:34 UTC
  • mto: This revision was merged to the branch mainline in revision 11.
  • Revision ID: jml@canonical.com-20081004035134-btksf423zsyvsaxr
Rename pyunit3k to testtools.

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
1
 
==================================
2
 
Notes for contributing to pyunit3k
3
 
==================================
 
1
===================================
 
2
Notes for contributing to testtools
 
3
===================================
4
4
 
5
5
Coding style
6
6
------------
10
10
For consistency with the standard library's ``unittest`` module, method names
11
11
are generally ``camelCase``.
12
12
 
13
 
pyunit3k supports Python 2.4 and later, so avoid any 2.5-only features like
 
13
testtools supports Python 2.4 and later, so avoid any 2.5-only features like
14
14
the ``with`` statement.
15
15
 
16
16
 
17
17
Copyright assignment
18
18
--------------------
19
19
 
20
 
Currently all code in pyunit3k is copyright Jonathan M. Lange.  For the sake
 
20
Currently all code in testtools is copyright Jonathan M. Lange.  For the sake
21
21
of licensing simplicity, copyright of contributed code needs to be assigned to
22
22
Jonathan M. Lange otherwise it cannot be accepted.  Please include an
23
23
appropriate statement of copyright assignment with contributions.
37
37
Source layout
38
38
-------------
39
39
 
40
 
The top-level directory contains the ``pyunit3k/`` package directory, and
 
40
The top-level directory contains the ``testtools/`` package directory, and
41
41
miscellaneous files like README and setup.py.
42
42
 
43
 
The ``pyunit3k/`` directory is the Python package itself.  It is separated
 
43
The ``testtools/`` directory is the Python package itself.  It is separated
44
44
into submodules for internal clarity, but all public APIs should be “promoted”
45
 
into the top-level package by importing them in ``pyunit3k/__init__.py``.
46
 
Users of pyunit3k should never import a submodule, they are just
 
45
into the top-level package by importing them in ``testtools/__init__.py``.
 
46
Users of testtools should never import a submodule, they are just
47
47
implementation details.
48
48
 
49
 
Tests belong in ``pyunit3k/tests/``.
 
49
Tests belong in ``testtools/tests/``.
50
50
 
51
51