admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SubmittingPatches: emphasize need to communicate non-default starting points

Browse Source 
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 <linusa@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Linus Arver
2023-07-14 06:01:32 +00:00
committed by Junio C Hamano
parent b5dbfe28a4
commit 5c98149ce4
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/SubmittingPatches
View File

@@ -318,9 +318,12 @@ or include any extra files which do not relate to what your patch
is trying to achieve. Make sure to review
your patch after generating it, to ensure accuracy. Before
sending out, please make sure it cleanly applies to the starting point you
have chosen in the "Choose a starting point" section,
and unless it targets the `master` branch (which is the default),
mark your patches as such.
have chosen in the "Choose a starting point" section.
NOTE: From the perspective of those reviewing your patch, the `master`
branch is the default expected starting point. So if you have chosen a
different starting point, please communicate this choice in your cover
letter.
[[send-patches]]