From: "Philip Oakley via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Philip Oakley <philipoakley@iee.email>,
Philip Oakley <philipoakley@iee.email>
Subject: [PATCH v2] README.md: add CodingGuidelines and a link for Translators
Date: Sun, 16 Jan 2022 16:11:30 +0000 [thread overview]
Message-ID: <pull.1115.v2.git.1642349490723.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1115.git.1642182615339.gitgitgadget@gmail.com>
From: Philip Oakley <philipoakley@iee.email>
The README.md does not use the GitHub Markdown URL links [1] of
[txt](url), rather the reference method [2] of trailing empty square
brackets. The references themselves are listed at the foot of the
document. Those footers are not shown by GitHub/GitLab rendering.
Also space out the list joining instructions and clarify that
subscription is via the majordomo address.
[1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
[2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
Signed-off-by: Philip Oakley <philipoakley@iee.email>
---
README.md: add CodingGuidelines and a link for Translators
Also space out the list joining instructions and clarify the
subscription via the majordomo address.
Signed-off-by: Philip Oakley philipoakley@iee.email
===================================================
cc: Philip Oakley philipoakley@iee.email cc: Junio C Hamano
gitster@pobox.com cc: Jiang Xin worldhello.net@gmail.com
changes since v1:
* Used reference style links, rather than lnk [url] style.
* added Jianf as L10 coordinator.
* note: Patch is a response to a user question on the "Git for Human
Beings" git-users list
https://groups.google.com/d/msgid/git-users/aa68b9c8-4cf4-4193-8af3-79d7e3feafbbn%40googlegroups.com
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1115
Range-diff vs v1:
1: ac6d0abbdde ! 1: 48cc30b7cc8 README.md: add CodingGuidelines and a link for Translators
@@ Metadata
## Commit message ##
README.md: add CodingGuidelines and a link for Translators
- Also space out the list joining instructions and clarify the subscription
- via the majordomo address.
+ The README.md does not use the GitHub Markdown URL links [1] of
+ [txt](url), rather the reference method [2] of trailing empty square
+ brackets. The references themselves are listed at the foot of the
+ document. Those footers are not shown by GitHub/GitLab rendering.
+
+ Also space out the list joining instructions and clarify that
+ subscription is via the majordomo address.
+
+ [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
+ [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
Signed-off-by: Philip Oakley <philipoakley@iee.email>
@@ README.md: installed).
requests, comments and patches to git@vger.kernel.org (read
-[Documentation/SubmittingPatches][] for instructions on patch submission).
+[Documentation/SubmittingPatches][] for instructions on patch submission
-+and [Documentation/CodingGuidelines]() ).
++and [Documentation/CodingGuidelines][]).
+
+Those wishing to help with error message translation (localization L10)
-+should see [po/README.md]()
-+(a `po` file is a portable object file for the translations).
++should see [po/README.md][] (a `po` file is a Portable Object file that
++holds the translations).
+
To subscribe to the list, send an email with just "subscribe git" in
-the body to majordomo@vger.kernel.org. The mailing list archives are
-available at <https://lore.kernel.org/git/>,
-+the body to majordomo@vger.kernel.org (not the list). The mailing list
-+archives are available at <https://lore.kernel.org/git/>,
++the body to majordomo@vger.kernel.org (not the Git list). The mailing
++list archives are available at <https://lore.kernel.org/git/>,
<http://marc.info/?l=git> and other archival sites.
Issues which are security relevant should be disclosed privately to
+@@ README.md: and the name as (depending on your mood):
+ [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
+ [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
+ [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
++[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
++[po/README.md]: po/README.md
+ \ No newline at end of file
README.md | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index f6f43e78deb..d2b061e3998 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,16 @@ installed).
The user discussion and development of Git take place on the Git
mailing list -- everyone is welcome to post bug reports, feature
requests, comments and patches to git@vger.kernel.org (read
-[Documentation/SubmittingPatches][] for instructions on patch submission).
+[Documentation/SubmittingPatches][] for instructions on patch submission
+and [Documentation/CodingGuidelines][]).
+
+Those wishing to help with error message translation (localization L10)
+should see [po/README.md][] (a `po` file is a Portable Object file that
+holds the translations).
+
To subscribe to the list, send an email with just "subscribe git" in
-the body to majordomo@vger.kernel.org. The mailing list archives are
-available at <https://lore.kernel.org/git/>,
+the body to majordomo@vger.kernel.org (not the Git list). The mailing
+list archives are available at <https://lore.kernel.org/git/>,
<http://marc.info/?l=git> and other archival sites.
Issues which are security relevant should be disclosed privately to
@@ -64,3 +70,5 @@ and the name as (depending on your mood):
[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
[Documentation/SubmittingPatches]: Documentation/SubmittingPatches
+[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
+[po/README.md]: po/README.md
\ No newline at end of file
base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
--
gitgitgadget
next prev parent reply other threads:[~2022-01-16 16:11 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-14 17:50 [PATCH] README.md: add CodingGuidelines and a link for Translators Philip Oakley via GitGitGadget
2022-01-14 20:54 ` Junio C Hamano
2022-01-15 0:08 ` Philip Oakley
2022-01-15 0:47 ` Junio C Hamano
2022-01-16 16:11 ` Philip Oakley via GitGitGadget [this message]
2022-01-16 22:47 ` [PATCH v2] " Junio C Hamano
2022-01-17 18:08 ` Philip Oakley
2022-01-17 9:00 ` Bagas Sanjaya
2022-01-17 17:52 ` Philip Oakley
2022-01-17 18:49 ` Junio C Hamano
2022-01-17 18:18 ` [PATCH v3] " Philip Oakley via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1115.v2.git.1642349490723.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=philipoakley@iee.email \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.