~ubuntu-branches/ubuntu/quantal/dulwich/quantal

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Bazaar Package Importer
  • Author(s): Jelmer Vernooij
  • Date: 2011-04-12 22:18:19 UTC
  • mfrom: (1.2.15 upstream)
  • Revision ID: james.westby@ubuntu.com-20110412221819-xmoseax1zcc1r4u0
Tags: 0.7.1-1
* Add missing Breaks: field to python-dulwich.
* Switch to debhelper 7, drop cdbs.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Coding style
 
2
------------
1
3
Where possible, please follow PEP8 with regard to coding style.
2
4
 
3
 
Furthermore, triple-quotes should always be """, single quotes are ' unless using "
4
 
would result in less escaping within the string.
 
5
Furthermore, triple-quotes should always be """, single quotes are ' unless
 
6
using " would result in less escaping within the string.
5
7
 
6
8
All functionality should be available in pure Python. Optional C
7
9
implementations may be written for performance reasons, but should never
8
10
replace the Python implementation. The C implementations should follow the
9
11
kernel/git coding style.
10
12
 
 
13
Public methods, functions and classes should all have doc strings. Please use
 
14
epydoc style docstrings to document parameters and return values.
 
15
You can generate the documentation by running "make doc".
 
16
 
11
17
Where possible please include updates to NEWS along with your improvements.
 
18
 
 
19
Running the tests
 
20
-----------------
 
21
To run the testsuite, you should be able to simply run "make check". This
 
22
will run the tests using unittest on Python 2.7 and higher, and using
 
23
unittest2 (which you will need to have installed) on older versions of Python.
 
24
 
 
25
 $ make check
 
26
 
 
27
Alternatively, if you have testtools installed you can run the testsuite by
 
28
overriding the test runner:
 
29
 
 
30
 $ make check TESTRUNNER=testtools.run