Documentation/SubmittingPatches - a suggested patch flow
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Feb 10, 2008 at 14:09 UTC
a941fb4a43472b7b4419c6f6776749791c4495ef
1 file changed
+35
Documentation/SubmittingPatches
+35
@@ -229,6 +229,41 @@ is more familiar with the issues and the area the patch attempts
229
to modify. "Tested-by:" says the patch was tested by the person
230
and found to have the desired effect.
231
232
+------------------------------------------------
233
+An ideal patch flow
234
+
235
+Here is an ideal patch flow for this project the current maintainer
236
+suggests to the contributors:
237
+
238
+ (0) You come up with an itch. You code it up.
239
+
240
+ (1) Send it to the list and cc people who may need to know about
241
+ the change.
242
+
243
+ The people who may need to know are the ones whose code you
244
+ are butchering. These people happen to be the ones who are
245
+ most likely to be knowledgeable enough to help you, but
246
+ they have no obligation to help you (i.e. you ask for help,
247
+ don't demand). "git log -p -- $area_you_are_modifying" would
248
+ help you find out who they are.
249
+
250
+ (2) You get comments and suggestions for improvements. You may
251
+ even get them in a "on top of your change" patch form.
252
+
253
+ (3) Polish, refine, and re-send to the list and the people who
254
+ spend their time to improve your patch. Go back to step (2).
255
+
256
+ (4) The list forms consensus that the last round of your patch is
257
+ good. Send it to the list and cc the maintainer.
258
+
259
+ (5) A topic branch is created with the patch and is merged to 'next',
260
+ and cooked further and eventually graduates to 'master'.
261
+
262
+In any time between the (2)-(3) cycle, the maintainer may pick it up
263
+from the list and queue it to 'pu', in order to make it easier for
264
+people play with it without having to pick up and apply the patch to
265
+their trees themselves.
266
+
267
------------------------------------------------
268
MUA specific hints
269