← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

How to maintain the NEWS file

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
65
65
If you change the behaviour of a command, please update its docstring
66
66
in bzrlib/commands.py.  This is displayed by the 'bzr help' command.
67
67
 
 
68
NEWS file
 
69
---------
 
70
 
68
71
If you make a user-visible change, please add a note to the NEWS file.
69
72
The description should be written to make sense to someone who's just
70
73
a user of bzr, not a developer: new functions or classes shouldn't be
72
75
bugs should be listed.  See the existing entries for an idea of what
73
76
should be done.
74
77
 
 
78
Within each release, entries in the news file should have the most
 
79
user-visible changes first.  So the order should be approximately:
 
80
 
 
81
 * changes to existing behaviour - the highest priority because the 
 
82
   user's existing knowledge is incorrect
 
83
 * new features - should be brought to their attention
 
84
 * bug fixes - may be of interest if the bug was affecting them, and
 
85
   should include the bug number if any
 
86
 * major documentation changes
 
87
 * changes to internal interfaces
 
88
 
 
89
People who made significant contributions to each change are listed in
 
90
parenthesis.  This can include reporting bugs (particularly with good
 
91
details or reproduction recipes), submitting patches, etc.
75
92
 
76
93
API documentation
77
94
-----------------