From: Philip Oakley <philipoakley@iee.email> Before being told how to submit patches, new contributors need to be told how to code for, or how to contribute translation to, the project. Add references to the CodingGuidelines and the README document on localization. Also, split out the instructions to join the list and clarify that subscription is via the majordomo address. We use GitHub Markdown reference [2,3] with trailing empty square brackets, to match existing text in the file. On GitHub/GitLab pages, the footer references matching the empty [] are not shown on the web page. We could switch to using [text](url) form [1] if we wanted to, but that is not done as part of this patch. [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 [3] https://github.github.com/gfm/#example-561 (and the para aboveit) 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@xxxxxxxxx cc: Jiang Xin worldhello.net@xxxxxxxxx cc: Bagas Sanjaya bagasdotme@xxxxxxxxx changes since V2: * extended the translation 'messages' description * updated commit message based on Junio's suggestion changes since v1: * Used reference style links, rather than lnk [url] style. * added Jiang 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-v3 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v3 Pull-Request: https://github.com/gitgitgadget/git/pull/1115 Range-diff vs v2: 1: 48cc30b7cc8 ! 1: 953a38091ac README.md: add CodingGuidelines and a link for Translators @@ Metadata ## Commit message ## README.md: add CodingGuidelines and a link for Translators - 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. + Before being told how to submit patches, new contributors need + to be told how to code for, or how to contribute translation to, + the project. Add references to the CodingGuidelines and the + README document on localization. - Also space out the list joining instructions and clarify that - subscription is via the majordomo address. + Also, split out the instructions to join the list and clarify + that subscription is via the majordomo address. + + We use GitHub Markdown reference [2,3] with trailing empty square + brackets, to match existing text in the file. On GitHub/GitLab + pages, the footer references matching the empty [] are not shown + on the web page. We could switch to using [text](url) form [1] + if we wanted to, but that is not done as part of this patch. [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 + [3] https://github.github.com/gfm/#example-561 (and the para aboveit) Signed-off-by: Philip Oakley <philipoakley@iee.email> @@ README.md: installed). +[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). ++Those wishing to help with error message, usage and informational message ++string translations (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@xxxxxxxxxxxxxxx. The mailing list archives are @@ README.md: and the name as (depending on your mood): [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..7ce4f05bae8 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@xxxxxxxxxxxxxxx (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, usage and informational message +string translations (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@xxxxxxxxxxxxxxx. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to majordomo@xxxxxxxxxxxxxxx (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 base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2 -- gitgitgadget
