1
============================
2
guidelines for modifying bzr
3
============================
5
* New functionality should have test cases. Preferably write the
6
test before writing the code.
8
In general, you can test at either the command-line level or the
9
internal API level. Choose whichever is appropriate: if adding a
10
new command, or a new command option, then call through run_bzr().
11
It is not necessary to do both.
13
* Before fixing a bug, write a test case so that it does not regress.
15
* Exceptions should be defined inside bzrlib.errors, so that we can
16
see the whole tree at a glance.
18
* Imports should be done at the top-level of the file, unless there is
19
a strong reason to have them lazily loaded when a particular
20
function runs. Import statements have a cost, so try to make sure
21
they don't run inside hot functions.
23
* Please write PEP-8__ compliant code.
25
One often-missed requirement is that the first line of docstrings
26
should be a self-contained one-sentence summary.
28
__ http://www.python.org/peps/pep-0008.html
30
* Module names should always be given fully-qualified,
31
i.e. ``bzrlib.hashcache`` not just ``hashcache``.
38
If you change the behaviour of a command, please update its docstring
39
in bzrlib/commands.py. This is displayed by the 'bzr help' command.
41
If you make a user-visible change, please add a note to the NEWS file.
42
The description should be written to make sense to someone who's just
43
a user of bzr, not a developer: new functions or classes shouldn't be
44
mentioned, but new commands, changes in behaviour or fixed nontrivial
45
bugs should be listed. See the existing entries for an idea of what
53
(The strategy described here is what we want to get to, but it's not
54
consistently followed in the code at the moment.)
56
bzrlib is intended to be a generically reusable library. It shouldn't
57
write messages to stdout or stderr, because some programs that use it
58
might want to display that information through a GUI or some other
61
We can distinguish two types of output from the library:
63
1. Structured data representing the progress or result of an
64
operation. For example, for a commit command this will be a list
65
of the modified files and the finally committed revision number
68
These should be exposed either through the return code or by calls
69
to a callback parameter.
71
A special case of this is progress indicators for long-lived
72
operations, where the caller should pass a ProgressBar object.
74
2. Unstructured log/debug messages, mostly for the benefit of the
75
developers or users trying to debug problems. This should always
76
be sent through ``bzrlib.trace`` and Python ``logging``, so that
77
it can be redirected by the client.
79
The distinction between the two is a bit subjective, but in general if
80
there is any chance that a library would want to see something as
81
structured data, we should make it so.
83
The policy about how output is presented in the text-mode client
84
should be only in the command-line tool.
88
In general tests should be placed in a file named test_FOO.py where
89
FOO is the logical thing under test. That file should be placed in the
90
tests subdirectory under the package being tested.
92
For example, tests for merge3 in bzrlib belong in bzrlib/tests/test_merge3.py.
96
Currently, bzr selftest is used to invoke tests.
97
You can provide a pattern argument to run a subset. For example,
98
to run just the whitebox tests, run bzr selftest --pattern .*whitebox.*
added
removed
HACKING
