README.md: add CodingGuidelines and a link for Translators
PATCH 1/1 README.md: add CodingGuidelines and a link for Translators
From: Philip Oakley <[email protected]>
Also space out the list joining instructions and clarify the subscription via the majordomo address.
---
README.md: add CodingGuidelines and a link for Translators
Also space out the list joining instructions and clarify the subscription via the majordomo address.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1115
README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-)
README.md +9 -3
@@ -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 [email protected] (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 for the translations). + To subscribe to the list, send an email with just "subscribe git" in -the body to [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (not the 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
base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
Signature · 1 line
gitgitgadget
Quoted 3 lines · Philip Oakley via GitGitGadget
From: Philip Oakley <[email protected]>
Also space out the list joining instructions and clarify the subscription
the instructions to join the list?
Quoted 4 lines
requests, comments and patches to [email protected] (read
-[Documentation/SubmittingPatches][] for instructions on patch submission). +[Documentation/SubmittingPatches][] for instructions on patch submission +and [Documentation/CodingGuidelines]() ).
Remind me the significance of using [] and () after [File Reference]?
README.md installed). · line 39
Quoted 2 lines
README.md +2
-0+Those wishing to help with error message translation (localization L10) +should see [po/README.md]()
Same here.
seems to indicate () is to enclose URL the text goes to, and if there is no URL to go to, perhaps it does the right thing, but the current page (which has "[Documentation/SubmittingPatches][]" and all other reference into in-tree files with that format) seems to render correctly with links that work, so...
Quoted 12 lines
README.md +4
-2+(a `po` file is a portable object file for the translations). + To subscribe to the list, send an email with just "subscribe git" in -the body to [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (not the 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 tobase-commit:
1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
Quoted 6 lines · Junio C Hamano
Quoted 3 lines · Philip Oakley via GitGitGadget
From: Philip Oakley <[email protected]>
Also space out the list joining instructions and clarify the subscription
the instructions to join the list?
Correct.
Quoted 6 lines
Quoted 5 lines
requests, comments and patches to [email protected] (read
-[Documentation/SubmittingPatches][] for instructions on patch submission). +[Documentation/SubmittingPatches][] for instructions on patch submission +and [Documentation/CodingGuidelines]() ).Remind me the significance of using [] and () after [File Reference]?
The [] is the original method used by the unchanged text, while the () appears to be the method required now.
Quoted 5 lines
README.md installed). · line 39
Quoted 3 lines
README.md +2
-0+Those wishing to help with error message translation (localization L10) +should see [po/README.md]()Same here.
Quoted 7 lines
seems to indicate () is to enclose URL the text goes to, and if there is no URL to go to, perhaps it does the right thing, but the current page (which has "[Documentation/SubmittingPatches][]" and all other reference into in-tree files with that format) seems to render correctly with links that work, so...
Unfortunately it [] is not working for me for the new additions. GitHub magic?
Quoted 13 lines
Quoted 13 lines
README.md +4
-2+(a `po` file is a portable object file for the translations). + To subscribe to the list, send an email with just "subscribe git" in -the body to [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (not the 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 tobase-commit:
1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
Quoted 2 lines · Philip Oakley
Unfortunately it
[]is not working for me for the new additions. GitHub magic?
Let's step back a bit.
Is there somebody reading README.md as a more generic MarkDown? I do not think our build procedure creates any rendered document from it.
My recollection was that we moved from README.txt to README.md for the sole purpose of showing it https://github.com/git/git/ as more than just a plain text, so it is a hard requirement that GitHub flavored MarkDown renderer is happy with whatever we write in the file.
If GitHub flavored MarkDown only supports [] and breaks with (), then there is no need for further discussion. We must stick to [] that has been working for us in the file.
On the other hand, if both () and [] work well at GitHub, I am OK to replace [] to (), so that it shows well at GitHub and also it can be used with other MarkDown renderers.
I prefer, from the organizational point of view, to see two patches, in this order, if we were to go that way.
[PATCH 1/2] README: link to more contributor documents
which uses [] (not ()). After this, README.md uses only [], including the two links you add in this step. And then
[PATCH 2/2] README: use "()", not "[]", to please more MarkDown processors
which replaces all uses of [] with ().
That would allow us to queue both, try them out, and we can back out [2/2] if GitHub's renderer does not like the result.
PATCH v2 1/1 README.md: add CodingGuidelines and a link for Translators
In reply to Philip Oakley via GitGitGadgetFrom: Philip Oakley <[email protected]>
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
---
README.md: add CodingGuidelines and a link for Translators
Also space out the list joining instructions and clarify the subscription via the majordomo address.
===================================================
cc: Philip Oakley [email protected] cc: Junio C Hamano [email protected] cc: Jiang Xin [email protected]
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
@@ README.md: installed).
requests, comments and patches to [email protected] (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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>,
-+the body to [email protected] (not the list). The mailing list -+archives are available at <https://lore.kernel.org/git/>,
++the body to [email protected] (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(-)
README.md +11 -3
@@ -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 [email protected] (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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (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
Signature · 1 line
gitgitgadget
Quoted 6 lines · Philip Oakley via GitGitGadget
From: Philip Oakley <[email protected]>
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.
Thanks for tracking down the differences.
The above only describes what we could do (i.e. use links instead of reference), and how the current document is rendered (i.e. footers are not shown). No changes come from the above description.
Quoted 2 lines
Also space out the list joining instructions and clarify that subscription is via the majordomo address.
So, seeing "Also" immediately after a paragraph that explains the status quo confused me a lot.
"Spell out the instructions to join the list, and clarify that the subscription is via the majordomo address" is indeed a part of what this patch does. Perhaps we need a separate paragraph _before_ this "Also".
So taking all together
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, spell out the instructions to join the list and ...
We use GitHub Markdown reference [2] with trailing empty square brackets, to match existing text in the file. On GitHub/GitLab pages, these references are not shown on the page, but it is OK because they are empty. We could switch to using [text](url) form [1] if we wanted to, but that is not done as part of this patch.
would be the presentation order that I would expect to be the most readable. I moved the discussion between URL link and reference, as it is merely a hint for future and not the core thing that needs to be explained to understand the changes in this commit.
Thanks.
Quoted 121 lines
[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-linksSigned-off-by Philip Oakley <[email protected]>---
README.md: add CodingGuidelines and a link for TranslatorsAlso space out the list joining instructions and clarify the subscription via the majordomo address.
Signed-off-by Philip Oakley [email protected]===================================================
cc: Philip Oakley [email protected] cc: Junio C Hamano [email protected] cc: Jiang Xin [email protected]
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/1115Range-diff vs v1:
1:
ac6d0abbdde! 1:48cc30b7cc8README.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-linksSigned-off-by Philip Oakley <[email protected]>@@ README.md: installed).
requests, comments and patches to [email protected] (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]()
-+(apofile is a portable object file for the translations). ++should see [po/README.md][] (apofile 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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>,
-+the body to [email protected] (not the list). The mailing list -+archives are available at <https://lore.kernel.org/git/>,
++the body to [email protected] (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(-)README.md +11
-3@@ -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 [email protected] (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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (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.mdbase-commit:
1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
Quoted 9 lines · Junio C Hamano
Quoted 6 lines · Philip Oakley via GitGitGadget
From: Philip Oakley <[email protected]>
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.
Thanks for tracking down the differences.
I found an additional GitHub link for the reference method (not easy to find), which I have added.
Quoted 31 lines
The above only describes what we could do (i.e. use links instead of reference), and how the current document is rendered (i.e. footers are not shown). No changes come from the above description.
Quoted 2 lines
Also space out the list joining instructions and clarify that subscription is via the majordomo address.
So, seeing "Also" immediately after a paragraph that explains the status quo confused me a lot.
"Spell out the instructions to join the list, and clarify that the subscription is via the majordomo address" is indeed a part of what this patch does. Perhaps we need a separate paragraph _before_ this "Also".
So taking all together
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, spell out the instructions to join the list and ...
We use GitHub Markdown reference [2] with trailing empty square brackets, to match existing text in the file. On GitHub/GitLab pages, these references are not shown on the page, but it is OK because they are empty. We could switch to using [text](url) form [1] if we wanted to, but that is not done as part of this patch.
Quoted 4 lines
would be the presentation order that I would expect to be the most readable. I moved the discussion between URL link and reference, as it is merely a hint for future and not the core thing that needs to be explained to understand the changes in this commit.
I've taken your suggestions and added a small clarification about the awkward empty square bracket links, which are repeated in the README's footer, but not shown on the Github rendered web page.. I also took Bagas' text changes for the readme itself
GGG V3 to follow,...
Thank you
Quoted 125 lines
Thanks.
Quoted 121 lines
[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-linksSigned-off-by Philip Oakley <[email protected]>---
README.md: add CodingGuidelines and a link for TranslatorsAlso space out the list joining instructions and clarify the subscription via the majordomo address.
Signed-off-by Philip Oakley [email protected]===================================================
cc: Philip Oakley [email protected] cc: Junio C Hamano [email protected] cc: Jiang Xin [email protected]
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/1115Range-diff vs v1:
1:
ac6d0abbdde! 1:48cc30b7cc8README.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-linksSigned-off-by Philip Oakley <[email protected]>@@ README.md: installed).
requests, comments and patches to [email protected] (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]()
-+(apofile is a portable object file for the translations). ++should see [po/README.md][] (apofile 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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>,
-+the body to [email protected] (not the list). The mailing list -+archives are available at <https://lore.kernel.org/git/>,
++the body to [email protected] (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(-)README.md +11
-3@@ -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 [email protected] (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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (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.mdbase-commit:
1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
README.md installed). · line 41
Quoted 4 lines · Philip Oakley via GitGitGadget
README.md +4
-0+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). +
I mean not just error messages are in po/*.po, but also usage and informational strings. We can say "Those wishing to help translating message strings (localization or l10n)...".
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 11 lines · Bagas Sanjaya
README.md installed). · line 41
Quoted 4 lines · Philip Oakley via GitGitGadget
README.md +4
-0+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). +I mean not just error messages are in po/*.po, but also usage and informational
strings. We can say "Those wishing to help translating message strings (localization or l10n)...".
Thanks, I've expended the README description.
Philip
Quoted 9 lines · Bagas Sanjaya
README.md installed). · line 41
Quoted 4 lines · Philip Oakley via GitGitGadget
README.md +4
-0+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). +I mean not just error messages are in po/*.po, but also usage and informational strings. We can say "Those wishing to help translating message strings (localization or l10n)...".
Yup, that sounds more correct.
Thanks.
PATCH v3 1/1 README.md: add CodingGuidelines and a link for Translators
In reply to Philip Oakley via GitGitGadgetFrom: Philip Oakley <[email protected]>
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)
---
README.md: add CodingGuidelines and a link for Translators
Also space out the list joining instructions and clarify the subscription via the majordomo address.
cc: Philip Oakley [email protected] cc: Junio C Hamano [email protected] cc: Jiang Xin [email protected] cc: Bagas Sanjaya [email protected]
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)
@@ 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 [email protected]. 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(-)
README.md +11 -3
@@ -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 [email protected] (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 [email protected]. The mailing list archives are -available at <https://lore.kernel.org/git/>, +the body to [email protected] (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
Signature · 1 line
gitgitgadget