Skip to content

Commit 5a322a2

Browse files
committed
Merge branch 'js/contributor-docs-updates' into maint-2.43
Doc update. * js/contributor-docs-updates: SubmittingPatches: hyphenate non-ASCII SubmittingPatches: clarify GitHub artifact format SubmittingPatches: clarify GitHub visual SubmittingPatches: provide tag naming advice SubmittingPatches: update extra tags list SubmittingPatches: discourage new trailers SubmittingPatches: drop ref to "What's in git.git" CodingGuidelines: write punctuation marks CodingGuidelines: move period inside parentheses
2 parents 232953b + 291873e commit 5a322a2

File tree

2 files changed

+25
-12
lines changed

2 files changed

+25
-12
lines changed

Documentation/CodingGuidelines

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ For C programs:
450450
one of the approved headers that includes it first for you. (The
451451
approved headers currently include "builtin.h",
452452
"t/helper/test-tool.h", "xdiff/xinclude.h", or
453-
"reftable/system.h"). You do not have to include more than one of
453+
"reftable/system.h".) You do not have to include more than one of
454454
these.
455455

456456
- A C file must directly include the header files that declare the
@@ -578,7 +578,7 @@ Externally Visible Names
578578
. The variable name describes the effect of tweaking this knob.
579579

580580
The section and variable names that consist of multiple words are
581-
formed by concatenating the words without punctuations (e.g. `-`),
581+
formed by concatenating the words without punctuation marks (e.g. `-`),
582582
and are broken using bumpyCaps in documentation as a hint to the
583583
reader.
584584

Documentation/SubmittingPatches

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -355,9 +355,21 @@ If you like, you can put extra tags at the end:
355355
patch after a detailed analysis.
356356
. `Tested-by:` is used to indicate that the person applied the patch
357357
and found it to have the desired effect.
358-
359-
You can also create your own tag or use one that's in common usage
360-
such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
358+
. `Co-authored-by:` is used to indicate that people exchanged drafts
359+
of a patch before submitting it.
360+
. `Helped-by:` is used to credit someone who suggested ideas for
361+
changes without providing the precise changes in patch form.
362+
. `Mentored-by:` is used to credit someone with helping develop a
363+
patch as part of a mentorship program (e.g., GSoC or Outreachy).
364+
. `Suggested-by:` is used to credit someone with suggesting the idea
365+
for a patch.
366+
367+
While you can also create your own trailer if the situation warrants it, we
368+
encourage you to instead use one of the common trailers in this project
369+
highlighted above.
370+
371+
Only capitalize the very first letter of tags, i.e. favor
372+
"Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".
361373

362374
[[git-tools]]
363375
=== Generate your patch using Git tools out of your commits.
@@ -570,7 +582,7 @@ their trees themselves.
570582
master).
571583

572584
* Read the Git mailing list, the maintainer regularly posts messages
573-
entitled "What's cooking in git.git" and "What's in git.git" giving
585+
entitled "What's cooking in git.git" giving
574586
the status of various proposed changes.
575587

576588
== GitHub CI[[GHCI]]
@@ -590,11 +602,12 @@ After the initial setup, CI will run whenever you push new changes
590602
to your fork of Git on GitHub. You can monitor the test state of all your
591603
branches here: `https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml`
592604

593-
If a branch did not pass all test cases then it is marked with a red
594-
cross. In that case you can click on the failing job and navigate to
595-
"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
596-
can also download "Artifacts" which are tarred (or zipped) archives
597-
with test data relevant for debugging.
605+
If a branch does not pass all test cases then it will be marked with a
606+
red +x+, instead of a green check. In that case, you can click on the
607+
failing job and navigate to "ci/run-build-and-tests.sh" and/or
608+
"ci/print-test-failures.sh". You can also download "Artifacts" which
609+
are zip archives containing tarred (or zipped) archives with test data
610+
relevant for debugging.
598611

599612
Then fix the problem and push your fix to your GitHub fork. This will
600613
trigger a new CI build to ensure all tests pass.
@@ -686,7 +699,7 @@ message to an external program, and this is a handy way to drive
686699
`git am`. However, if the message is MIME encoded, what is
687700
piped into the program is the representation you see in your
688701
`*Article*` buffer after unwrapping MIME. This is often not what
689-
you would want for two reasons. It tends to screw up non ASCII
702+
you would want for two reasons. It tends to screw up non-ASCII
690703
characters (most notably in people's names), and also
691704
whitespaces (fatal in patches). Running "C-u g" to display the
692705
message in raw form before using "|" to run the pipe can work

0 commit comments

Comments
 (0)