[PATCH v2] README.md: add CodingGuidelines and a link for Translators
- From
Philip Oakley via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Jan 16, 2022, 16:11 UTC
- Message-ID
- <pull.1115.v2.git.1642349490723.gitgitgadget@gmail.com>
- 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.comPublished-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 fileREADME.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