← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Martin Pool
  • Date: 2005-08-17 02:11:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050817021125-178eae78b609dad8
- note for contributors to please update the NEWS file

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
 
1
============================
1
2
guidelines for modifying bzr
2
3
============================
3
4
 
24
25
__ http://www.python.org/peps/pep-0008.html
25
26
 
26
27
* Module names should always be given fully-qualified,
27
 
  i.e. ``bzrlib.hashcache`` not just ``hashcache``.
 
 
b'\\ No newline at end of file'
 
28
  i.e. ``bzrlib.hashcache`` not just ``hashcache``.
 
29
 
 
30
 
 
31
 
 
32
Documentation
 
33
=============
 
34
 
 
35
If you change the behaviour of a command, please update its docstring
 
36
in bzrlib/commands.py.  This is displayed by the 'bzr help' command.
 
37
 
 
38
If you make a user-visible change, please add a note to the NEWS file.
 
39
The description should be written to make sense to someone who's just
 
40
a user of bzr, not a developer: new functions or classes shouldn't be
 
41
mentioned, but new commands, changes in behaviour or fixed nontrivial
 
42
bugs should be listed.  See the existing entries for an idea of what
 
43
should be done.