diff options
Diffstat (limited to 'SubmittingPatches.html')
-rw-r--r-- | SubmittingPatches.html | 50 |
1 files changed, 39 insertions, 11 deletions
diff --git a/SubmittingPatches.html b/SubmittingPatches.html index 8835e3fe3..e01b8d8e4 100644 --- a/SubmittingPatches.html +++ b/SubmittingPatches.html @@ -735,7 +735,7 @@ asciidoc.install(); <body class="article">
<div id="header">
<h1>Submitting Patches</h1>
-<span id="revdate">2024-01-08</span>
+<span id="revdate">2024-01-12</span>
</div>
<div id="content">
<div class="sect1">
@@ -1144,9 +1144,36 @@ don’t hide your real name.</p></div> and found it to have the desired effect.
</p>
</li>
+<li>
+<p>
+<code>Co-authored-by:</code> is used to indicate that people exchanged drafts
+ of a patch before submitting it.
+</p>
+</li>
+<li>
+<p>
+<code>Helped-by:</code> is used to credit someone who suggested ideas for
+ changes without providing the precise changes in patch form.
+</p>
+</li>
+<li>
+<p>
+<code>Mentored-by:</code> is used to credit someone with helping develop a
+ patch as part of a mentorship program (e.g., GSoC or Outreachy).
+</p>
+</li>
+<li>
+<p>
+<code>Suggested-by:</code> is used to credit someone with suggesting the idea
+ for a patch.
+</p>
+</li>
</ol></div>
-<div class="paragraph"><p>You can also create your own tag or use one that’s in common usage
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".</p></div>
+<div class="paragraph"><p>While you can also create your own trailer if the situation warrants it, we
+encourage you to instead use one of the common trailers in this project
+highlighted above.</p></div>
+<div class="paragraph"><p>Only capitalize the very first letter of tags, i.e. favor
+"Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".</p></div>
</div>
<div class="sect2">
<h3 id="git-tools">Generate your patch using Git tools out of your commits.</h3>
@@ -1388,7 +1415,7 @@ You can use Git itself to find out when your patch is merged in <li>
<p>
Read the Git mailing list, the maintainer regularly posts messages
- entitled "What’s cooking in git.git" and "What’s in git.git" giving
+ entitled "What’s cooking in git.git" giving
the status of various proposed changes.
</p>
</li>
@@ -1415,11 +1442,12 @@ Fork <a href="https://github.com/git/git">https://github.com/git/git</a> to your <div class="paragraph"><p>After the initial setup, CI will run whenever you push new changes
to your fork of Git on GitHub. You can monitor the test state of all your
branches here: <code>https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml</code></p></div>
-<div class="paragraph"><p>If a branch did not pass all test cases then it is marked with a red
-cross. In that case you can click on the failing job and navigate to
-"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
-can also download "Artifacts" which are tarred (or zipped) archives
-with test data relevant for debugging.</p></div>
+<div class="paragraph"><p>If a branch does not pass all test cases then it will be marked with a
+red <code>x</code>, instead of a green check. In that case, you can click on the
+failing job and navigate to "ci/run-build-and-tests.sh" and/or
+"ci/print-test-failures.sh". You can also download "Artifacts" which
+are zip archives containing tarred (or zipped) archives with test data
+relevant for debugging.</p></div>
<div class="paragraph"><p>Then fix the problem and push your fix to your GitHub fork. This will
trigger a new CI build to ensure all tests pass.</p></div>
</div>
@@ -1505,7 +1533,7 @@ message to an external program, and this is a handy way to drive <code>git am</code>. However, if the message is MIME encoded, what is
piped into the program is the representation you see in your
<code>*Article*</code> buffer after unwrapping MIME. This is often not what
-you would want for two reasons. It tends to screw up non ASCII
+you would want for two reasons. It tends to screw up non-ASCII
characters (most notably in people’s names), and also
whitespaces (fatal in patches). Running "C-u g" to display the
message in raw form before using "|" to run the pipe can work
@@ -1518,7 +1546,7 @@ this problem around.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-11-20 08:57:08 PST
+ 2024-01-12 16:26:55 PST
</div>
</div>
</body>
|