Skip to content

Commit 4ed7dfa

Browse files
PhilipOakleygitster
authored andcommitted
README.md: add CodingGuidelines and a link for Translators
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e9d7761 commit 4ed7dfa

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,16 @@ installed).
3232
The user discussion and development of Git take place on the Git
3333
mailing list -- everyone is welcome to post bug reports, feature
3434
requests, comments and patches to [email protected] (read
35-
[Documentation/SubmittingPatches][] for instructions on patch submission).
35+
[Documentation/SubmittingPatches][] for instructions on patch submission
36+
and [Documentation/CodingGuidelines][]).
37+
38+
Those wishing to help with error message, usage and informational message
39+
string translations (localization l10) should see [po/README.md][]
40+
(a `po` file is a Portable Object file that holds the translations).
41+
3642
To subscribe to the list, send an email with just "subscribe git" in
37-
the body to [email protected]. The mailing list archives are
38-
available at <https://lore.kernel.org/git/>,
43+
the body to [email protected] (not the Git list). The mailing
44+
list archives are available at <https://lore.kernel.org/git/>,
3945
<http://marc.info/?l=git> and other archival sites.
4046

4147
Issues which are security relevant should be disclosed privately to
@@ -64,3 +70,5 @@ and the name as (depending on your mood):
6470
[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
6571
[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
6672
[Documentation/SubmittingPatches]: Documentation/SubmittingPatches
73+
[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
74+
[po/README.md]: po/README.md

0 commit comments

Comments
 (0)