[0/8] Minor improvements to CodingGuidelines and SubmittingPatches

Message

Derrick Stolee via GitGitGadget Dec. 19, 2023, 8:41 a.m. UTC

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 (8):
  CodingGuidelines: move period inside parentheses
  CodingGuidelines: write punctuation marks
  SubmittingPatches: drop ref to "What's in git.git"
  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 | 24 +++++++++++++++++++-----
 2 files changed, 21 insertions(+), 7 deletions(-)


base-commit: 624eb90fa8f65a79396615f3c2842ac5a3743350
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1623%2Fjsoref%2Fdocumentation-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1623/jsoref/documentation-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1623

Comments

Elijah Newren Dec. 20, 2023, 3:43 p.m. UTC | #1

On Tue, Dec 19, 2023 at 12:42 AM Josh Soref via GitGitGadget
<[e-mail]> wrote:
>
> 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

I commented on patches 4, 6, and 7 suggesting some changes.  Patch 1
is "meh" to me, but it doesn't hurt anything.  The other four all look
like good cleanups to me.