Skip to content

Commit 5c98149

Browse files
Linus Arvergitster
authored andcommitted
SubmittingPatches: emphasize need to communicate non-default starting points
The phrase and unless it targets the `master` branch (which is the default), mark your patches as such. is tightly packed with several things happening in just two lines of text. It also feels like it is not that important because of the terse treatment. This is a problem because (1) it has the potential to confuse new contributors, and (2) it may be glossed over for those skimming the docs. Emphasize and elaborate on this guidance by promoting it to its own separate paragraph. Signed-off-by: Linus Arver <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b5dbfe2 commit 5c98149

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Documentation/SubmittingPatches

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,12 @@ or include any extra files which do not relate to what your patch
318318
is trying to achieve. Make sure to review
319319
your patch after generating it, to ensure accuracy. Before
320320
sending out, please make sure it cleanly applies to the starting point you
321-
have chosen in the "Choose a starting point" section,
322-
and unless it targets the `master` branch (which is the default),
323-
mark your patches as such.
321+
have chosen in the "Choose a starting point" section.
322+
323+
NOTE: From the perspective of those reviewing your patch, the `master`
324+
branch is the default expected starting point. So if you have chosen a
325+
different starting point, please communicate this choice in your cover
326+
letter.
324327

325328

326329
[[send-patches]]

0 commit comments

Comments
 (0)