git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 0/9] Minor improvements to CodingGuidelines and SubmittingPatches

From
Josh Soref via GitGitGadget <gitgitgadget@gmail.com>
Date
Dec 21, 2023, 16:40 UTC
Message-ID
<pull.1623.v2.git.1703176865.gitgitgadget@gmail.com>
In-Reply-To
<pull.1623.git.1702975319.gitgitgadget@gmail.com>

These are a bunch of things I've run into over my past couple of attempts to contribute to Git.

 * Incremental punctuation/grammatical improvements
 * Update extra tags suggestions based on common usage
 * drop reference to an article that was discontinued over a decade ago
 * update GitHub references
 * harmonize non-ASCII while I'm here

Note that I'm trying to do things "in the neighborhood". It'll be slower than me replacing things topically, but hopefully easier for others to digest. My current estimate is a decade or two :).

Josh Soref (9):
  CodingGuidelines: move period inside parentheses
  CodingGuidelines: write punctuation marks
  SubmittingPatches: drop ref to "What's in git.git"
  SubmittingPatches: discourage new trailers
  SubmittingPatches: update extra tags list
  SubmittingPatches: improve extra tags advice
  SubmittingPatches: clarify GitHub visual
  SubmittingPatches: clarify GitHub artifact format
  SubmittingPatches: hyphenate non-ASCII
 Documentation/CodingGuidelines  |  4 ++--
 Documentation/SubmittingPatches | 27 ++++++++++++++++++++-------
 2 files changed, 22 insertions(+), 9 deletions(-)
base-commit: 624eb90fa8f65a79396615f3c2842ac5a3743350
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1623%2Fjsoref%2Fdocumentation-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1623/jsoref/documentation-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1623
Range-diff vs v1:
  1:  b9a8eb6aa4e =  1:  b9a8eb6aa4e CodingGuidelines: move period inside parentheses
  2:  c0db8336e51 =  2:  c0db8336e51 CodingGuidelines: write punctuation marks
  3:  22d66c5b78a =  3:  22d66c5b78a SubmittingPatches: drop ref to "What's in git.git"
  4:  e5c7f29af43 !  4:  eac2211332f SubmittingPatches: update extra tags list
     @@ Metadata
      Author: Josh Soref <jsoref@gmail.com>
      
       ## Commit message ##
     -    SubmittingPatches: update extra tags list
     +    SubmittingPatches: discourage new trailers
      
     -    Add items with at least 100 uses:
     -    - Co-authored-by
     -    - Helped-by
     -    - Mentored-by
     -    - Suggested-by
     -
     -    Updating the create suggestion to something less commonly used.
     -
     -    git log |
     -      perl -ne 'next unless /^\s+[A-Z][a-z]+-\S+:/;s/^\s+//;s/:.*/:/;print'|
     -      sort|uniq -c|sort -n|grep '[0-9][0-9] '
     -      11 Helped-By:
     -      13 Message-ID:
     -      14 Reported-By:
     -      22 Acked-By:
     -      27 Inspired-by:
     -      29 Requested-by:
     -      35 Original-patch-by:
     -      43 Contributions-by:
     -      47 Signed-Off-By:
     -      65 Based-on-patch-by:
     -      68 Thanks-to:
     -      88 Improved-by:
     -     145 Co-authored-by:
     -     171 Noticed-by:
     -     182 Tested-by:
     -     361 Suggested-by:
     -     469 Mentored-by:
     -    1196 Reported-by:
     -    1727 Helped-by:
     -    2177 Reviewed-by:
     -    2202 Acked-by:
     -    95313 Signed-off-by:
     +    There seems to be consensus amongst the core Git community on a working
     +    set of common trailers, and there are non-trivial costs to people
     +    inventing new trailers (research to discover what they mean/how they
     +    differ from existing trailers) such that inventing new ones is generally
     +    unwarranted and not something to be recommended to new contributors.
      
     +    Suggested-by: Elijah Newren <newren@gmail.com>
          Signed-off-by: Josh Soref <jsoref@gmail.com>
      
       ## Documentation/SubmittingPatches ##
      @@ Documentation/SubmittingPatches: If you like, you can put extra tags at the end:
     - 
     - . `Reported-by:` is used to credit someone who found the bug that
     -   the patch attempts to fix.
     -+. `Noticed-by:` liked `Reported-by:` indicates someone who noticed
     -+  the item being fixed.
     - . `Acked-by:` says that the person who is more familiar with the area
     -   the patch attempts to modify liked the patch.
     - . `Reviewed-by:`, unlike the other tags, can only be offered by the
     -@@ Documentation/SubmittingPatches: If you like, you can put extra tags at the end:
     -   patch after a detailed analysis.
       . `Tested-by:` is used to indicate that the person applied the patch
         and found it to have the desired effect.
     -+. `Co-authored-by:` is used to indicate that multiple people
     -+  contributed to the work of a patch.
     -+. `Helped-by:` is used to credit someone with helping develop a
     -+  patch.
     -+. `Mentored-by:` is used to credit someone with helping develop a
     -+  patch.
     -+. `Suggested-by:` is used to credit someone with suggesting the idea
     -+  for a patch.
       
     - You can also create your own tag or use one that's in common usage
     +-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:".
     -+such as "Thanks-to:", "Based-on-patch-by:", or "Improved-by:".
     ++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.
       
       [[git-tools]]
       === Generate your patch using Git tools out of your commits.
  -:  ----------- >  5:  8848572fe2c SubmittingPatches: update extra tags list
  5:  11688e4360c !  6:  8f16c7caa73 SubmittingPatches: improve extra tags advice
     @@ Commit message
          Signed-off-by: Josh Soref <jsoref@gmail.com>
      
       ## Documentation/SubmittingPatches ##
     -@@ Documentation/SubmittingPatches: If you like, you can put extra tags at the end:
     - You can also create your own tag or use one that's in common usage
     - such as "Thanks-to:", "Based-on-patch-by:", or "Improved-by:".
     +@@ Documentation/SubmittingPatches: 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.
       
      +Extra tags should only capitalize the very first letter, i.e. favor
      +"Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".
  6:  043d2a24202 !  7:  cdb5fd0957f SubmittingPatches: clarify GitHub visual
     @@ Metadata
       ## Commit message ##
          SubmittingPatches: clarify GitHub visual
      
     -    Some people would expect a cross to be upright, and potentially have
     -    unequal lengths...
     +    GitHub has two general forms for its states, sometimes they're a simple
     +    colored object (e.g. green check or red x), and sometimes there's also a
     +    colored container (e.g. green box or red circle) with containing that
     +    object (e.g. check or x).
      
     -    GitHub uses a white x overlaying a solid red circle to indicate failure.
     +    That's a lot of words to try to describe things, but in general, the key
     +    for a failure is that it's recognized as an `x` and that it's associated
     +    with the color red -- the color of course is problematic for people who
     +    are red-green color-blind, but that's why they are paired with distinct
     +    shapes.
     +
     +    Using the term `cross` doesn't really help.
      
          Signed-off-by: Josh Soref <jsoref@gmail.com>
      
  7:  cdab65a4259 !  8:  77576327df8 SubmittingPatches: clarify GitHub artifact format
     @@ Commit message
      
          GitHub wraps artifacts generated by workflows in a .zip file.
      
     -    Internally workflows can package anything they like in them.
     +    Internally, workflows can package anything they like in them.
      
          A recently generated failure artifact had the form:
      
  8:  92469324813 =  9:  a4878f58fe4 SubmittingPatches: hyphenate non-ASCII
-- 
gitgitgadget
Previous: Elijah NewrenNext: Josh Soref via GitGitGadget
Message 25 of 55 in “Minor improvements to CodingGuidelines and SubmittingPatches”
  1. 0/8 Minor improvements to CodingGuidelines and SubmittingPatchesJosh Soref via GitGitGadget, Dec 19, 2023
  2. 1/8 CodingGuidelines: move period inside parenthesesJosh Soref via GitGitGadget, Dec 19, 2023
  3. 2/8 CodingGuidelines: write punctuation marksJosh Soref via GitGitGadget, Dec 19, 2023
  4. 3/8 SubmittingPatches: drop ref to "What's in git.git"Josh Soref via GitGitGadget, Dec 19, 2023
  5. 4/8 SubmittingPatches: update extra tags listJosh Soref via GitGitGadget, Dec 19, 2023
  6. Phillip WoodDec 20, 2023
  7. Elijah NewrenDec 20, 2023
  8. Josh SorefDec 20, 2023
  9. Elijah NewrenDec 20, 2023
  10. Josh SorefDec 20, 2023
  11. phillip.wood123@gmail.comDec 21, 2023
  12. Junio C HamanoDec 20, 2023
  13. 5/8 SubmittingPatches: improve extra tags adviceJosh Soref via GitGitGadget, Dec 19, 2023
  14. 6/8 SubmittingPatches: clarify GitHub visualJosh Soref via GitGitGadget, Dec 19, 2023
  15. René ScharfeDec 19, 2023
  16. Elijah NewrenDec 20, 2023
  17. Josh SorefDec 20, 2023
  18. Junio C HamanoDec 20, 2023
  19. 7/8 SubmittingPatches: clarify GitHub artifact formatJosh Soref via GitGitGadget, Dec 19, 2023
  20. Elijah NewrenDec 20, 2023
  21. Josh SorefDec 20, 2023
  22. Elijah NewrenDec 20, 2023
  23. 8/8 SubmittingPatches: hyphenate non-ASCIIJosh Soref via GitGitGadget, Dec 19, 2023
  24. Elijah NewrenDec 20, 2023
  25. 0/9 Minor improvements to CodingGuidelines and SubmittingPatchesJosh Soref via GitGitGadget, Dec 21, 2023
  26. 1/9 CodingGuidelines: move period inside parenthesesJosh Soref via GitGitGadget, Dec 21, 2023
  27. Junio C HamanoDec 21, 2023
  28. Josh SorefDec 21, 2023
  29. Dragan SimicDec 22, 2023
  30. 2/9 CodingGuidelines: write punctuation marksJosh Soref via GitGitGadget, Dec 21, 2023
  31. Junio C HamanoDec 21, 2023
  32. Josh SorefDec 21, 2023
  33. Junio C HamanoDec 21, 2023
  34. 3/9 SubmittingPatches: drop ref to "What's in git.git"Josh Soref via GitGitGadget, Dec 21, 2023
  35. Junio C HamanoDec 21, 2023
  36. 4/9 SubmittingPatches: discourage new trailersJosh Soref via GitGitGadget, Dec 21, 2023
  37. 5/9 SubmittingPatches: update extra tags listJosh Soref via GitGitGadget, Dec 21, 2023
  38. Junio C HamanoDec 21, 2023
  39. Josh SorefDec 21, 2023
  40. 6/9 SubmittingPatches: improve extra tags adviceJosh Soref via GitGitGadget, Dec 21, 2023
  41. Junio C HamanoDec 21, 2023
  42. 7/9 SubmittingPatches: clarify GitHub visualJosh Soref via GitGitGadget, Dec 21, 2023
  43. Junio C HamanoDec 21, 2023
  44. 8/9 SubmittingPatches: clarify GitHub artifact formatJosh Soref via GitGitGadget, Dec 21, 2023
  45. 9/9 SubmittingPatches: hyphenate non-ASCIIJosh Soref via GitGitGadget, Dec 21, 2023
  46. 0/9 Minor improvements to CodingGuidelines and SubmittingPatchesJosh Soref via GitGitGadget, Dec 28, 2023
  47. 1/9 CodingGuidelines: move period inside parenthesesJosh Soref via GitGitGadget, Dec 28, 2023
  48. 2/9 CodingGuidelines: write punctuation marksJosh Soref via GitGitGadget, Dec 28, 2023
  49. 3/9 SubmittingPatches: drop ref to "What's in git.git"Josh Soref via GitGitGadget, Dec 28, 2023
  50. 4/9 SubmittingPatches: discourage new trailersJosh Soref via GitGitGadget, Dec 28, 2023
  51. 5/9 SubmittingPatches: update extra tags listJosh Soref via GitGitGadget, Dec 28, 2023
  52. 6/9 SubmittingPatches: provide tag naming adviceJosh Soref via GitGitGadget, Dec 28, 2023
  53. 7/9 SubmittingPatches: clarify GitHub visualJosh Soref via GitGitGadget, Dec 28, 2023
  54. 8/9 SubmittingPatches: clarify GitHub artifact formatJosh Soref via GitGitGadget, Dec 28, 2023
  55. 9/9 SubmittingPatches: hyphenate non-ASCIIJosh Soref via GitGitGadget, Dec 28, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.