Skip to content

Commit 69c13a7

Browse files
bagasmejiangxin
authored andcommitted
l10n: README: document l10n conventions
Document the conventions that l10n contributors must follow. Signed-off-by: Bagas Sanjaya <[email protected]> Signed-off-by: Jiang Xin <[email protected]>
1 parent 2fb9d25 commit 69c13a7

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

po/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,4 +340,50 @@ Usage for git-po-helper:
340340

341341
Run "git-po-helper" without arguments to show usage.
342342

343+
344+
Conventions
345+
-----------
346+
347+
There are some conventions that l10n contributors must follow:
348+
349+
1. The subject of each l10n commit should be prefixed with "l10n: ".
350+
2. Do not use non-ASCII characters in the subject of a commit.
351+
3. The length of commit subject (first line of the commit log) should
352+
be less than 50 characters, and the length of other lines of the
353+
commit log should be no more than 72 characters.
354+
4. Add "Signed-off-by" trailer to your commit log, like other commits
355+
in Git. You can automatically add the trailer by committing with
356+
the following command:
357+
358+
git commit -s
359+
360+
5. Check syntax with "msgfmt" or the following command before creating
361+
your commit:
362+
363+
git-po-helper check-po <XX.po>
364+
365+
6. Squash trivial commits to make history clear.
366+
7. DO NOT edit files outside "po/" directory.
367+
8. Other subsystems ("git-gui", "gitk", and Git itself) have their
368+
own workflow. See [Documentation/SubmittingPatches][] for
369+
instructions on how to contribute patches to these subsystems.
370+
371+
To contribute for a new l10n language, contributor should follow
372+
additional conventions:
373+
374+
1. Initialize proper filename of the "XX.po" file conforming to
375+
iso-639 and iso-3166.
376+
2. Must complete a minimal translation based on the "po-core/core.pot"
377+
template. Using the following command to initialize the minimal
378+
"po-core/XX.po" file:
379+
380+
git-po-helper init --core <your-language>
381+
382+
3. Add a new entry in the "po/TEAMS" file with proper format, and check
383+
the syntax of "po/TEAMS" by runnning the following command:
384+
385+
git-po-helper team --check
386+
387+
343388
[git-po-helper/README]: https://github.com/git-l10n/git-po-helper#readme
389+
[Documentation/SubmittingPatches]: Documentation/SubmittingPatches

0 commit comments

Comments
 (0)