/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Martin Pool
  • Date: 2010-05-14 13:34:22 UTC
  • mto: This revision was merged to the branch mainline in revision 5252.
  • Revision ID: mbp@canonical.com-20100514133422-zcr5tt9vwy5ww1jj
Clean up and improve code review and contribution guidelines. 

Detangle "how to contribute code" from "how to review contributions".

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING.txt
128
128
"Propose for merging into another branch".  Select "~bzr/bzr/trunk" to hand
129
129
your changes off to the Bazaar developers for review and merging.
130
130
 
 
131
Alternatively, after pushing you can use the ``lp-propose`` command to 
 
132
create the merge proposal.
 
133
 
131
134
Using a meaningful name for your branch will help you and the reviewer(s)
132
135
better track the submission. Use a very succint description of your submission
133
136
and prefix it with bug number if needed (lp:~mbp/bzr/484558-merge-directory
135
138
(lp:~jameinel/bzr/export-file-511987).
136
139
 
137
140
 
 
141
Review cover letters
 
142
--------------------
 
143
 
 
144
Please put a "cover letter" on your merge request explaining:
 
145
 
 
146
* the reason **why** you're making this change
 
147
 
 
148
* **how** this change achieves this purpose
 
149
 
 
150
* anything else you may have fixed in passing
 
151
 
 
152
* anything significant that you thought of doing, such as a more
 
153
  extensive fix or a different approach, but didn't or couldn't do now
 
154
 
 
155
A good cover letter makes reviewers' lives easier because they can decide
 
156
from the letter whether they agree with the purpose and approach, and then
 
157
assess whether the patch actually does what the cover letter says.
 
158
Explaining any "drive-by fixes" or roads not taken may also avoid queries
 
159
from the reviewer.  All in all this should give faster and better reviews.
 
160
Sometimes writing the cover letter helps the submitter realize something
 
161
else they need to do.  The size of the cover letter should be proportional
 
162
to the size and complexity of the patch.
 
163
 
 
164
 
138
165
Why make a local copy of bzr.dev?
139
166
---------------------------------
140
167