diff mbox series

[3/3] po/README: document l10n conventions

Message ID 20210311125511.51152-4-bagasdotme@gmail.com (mailing list archive)
State New, archived
Headers show
Series po/README: document miscellaneous topics mentioned by l10n coordinator | expand

Commit Message

Bagas Sanjaya March 11, 2021, 12:55 p.m. UTC
Document things that l10n contributors must folow.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 po/README | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Comments

Bagas Sanjaya March 11, 2021, 1:13 p.m. UTC | #1
On 11/03/21 19.55, Bagas Sanjaya wrote:
> Document things that l10n contributors must folow.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>   po/README | 21 +++++++++++++++++++++
>   1 file changed, 21 insertions(+)

Oh oh oh, typo there. folow -> follow.

> diff --git a/po/README b/po/README
> index eda7edf4e6..e1a0494b17 100644
> --- a/po/README
> +++ b/po/README
> @@ -344,3 +344,24 @@ Below are the usage examples:
>           po-helper.sh check XX.po
>   
>   Run po-helper.sh without arguments for usage help.
> +
> +
> +Conventions
> +-----------
> +
> +There are some conventions that l10n contributors must follow:
> +
> +   1. The subject of each commit should be prefixed with `l10n: `.
> +   2. The length of commit log title (subject) should be less than 50
> +      characters, and the length of other lines (commit log body)
> +      should be no more than 72 characters.
> +   3. Add "Signed-off-by" trailer to your commit log, like other
> +      commits in Git. You can automatically add the trailer by
> +      committing with `git commit -s`.
> +   4. Check syntax with `msgfmt` or `po-helper.sh check` before
> +      committing.
> +   5. Squash trivial commits to make history clear.
> +   6. Do NOT edit files outside po/ directory.
> +   7. Other subsystems ("git-gui", "gitk", and Git itself) have their
> +      own workflow. See Documentation/SubmittingPatches if you want
> +      to make contributions to these subsystems.
>
Jiang Xin March 12, 2021, 1:33 a.m. UTC | #2
Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
>
> Document things that l10n contributors must folow.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  po/README | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
>
> diff --git a/po/README b/po/README
> index eda7edf4e6..e1a0494b17 100644
> --- a/po/README
> +++ b/po/README
> @@ -344,3 +344,24 @@ Below are the usage examples:
>          po-helper.sh check XX.po
>
>  Run po-helper.sh without arguments for usage help.
> +
> +
> +Conventions
> +-----------
> +
> +There are some conventions that l10n contributors must follow:
> +
> +   1. The subject of each commit should be prefixed with `l10n: `.
> +   2. The length of commit log title (subject) should be less than 50
> +      characters, and the length of other lines (commit log body)
> +      should be no more than 72 characters.
> +   3. Add "Signed-off-by" trailer to your commit log, like other
> +      commits in Git. You can automatically add the trailer by
> +      committing with `git commit -s`.
> +   4. Check syntax with `msgfmt` or `po-helper.sh check` before
> +      committing.
> +   5. Squash trivial commits to make history clear.
> +   6. Do NOT edit files outside po/ directory.
> +   7. Other subsystems ("git-gui", "gitk", and Git itself) have their
> +      own workflow. See Documentation/SubmittingPatches if you want
> +      to make contributions to these subsystems.

This patch 3/3 can be merged before we reimplement the utility `git-po-helper`.

--
Jiang Xin
Bagas Sanjaya March 12, 2021, 11:47 a.m. UTC | #3
On 12/03/21 08.33, Jiang Xin wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
>>
>> Document things that l10n contributors must folow.
>>
>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>> ---
>>   po/README | 21 +++++++++++++++++++++
>>   1 file changed, 21 insertions(+)
>>
>> diff --git a/po/README b/po/README
>> index eda7edf4e6..e1a0494b17 100644
>> --- a/po/README
>> +++ b/po/README
>> @@ -344,3 +344,24 @@ Below are the usage examples:
>>           po-helper.sh check XX.po
>>
>>   Run po-helper.sh without arguments for usage help.
>> +
>> +
>> +Conventions
>> +-----------
>> +
>> +There are some conventions that l10n contributors must follow:
>> +
>> +   1. The subject of each commit should be prefixed with `l10n: `.
>> +   2. The length of commit log title (subject) should be less than 50
>> +      characters, and the length of other lines (commit log body)
>> +      should be no more than 72 characters.
>> +   3. Add "Signed-off-by" trailer to your commit log, like other
>> +      commits in Git. You can automatically add the trailer by
>> +      committing with `git commit -s`.
>> +   4. Check syntax with `msgfmt` or `po-helper.sh check` before
>> +      committing.
>> +   5. Squash trivial commits to make history clear.
>> +   6. Do NOT edit files outside po/ directory.
>> +   7. Other subsystems ("git-gui", "gitk", and Git itself) have their
>> +      own workflow. See Documentation/SubmittingPatches if you want
>> +      to make contributions to these subsystems.
> 
> This patch 3/3 can be merged before we reimplement the utility `git-po-helper`.
> 
> --
> Jiang Xin
> 
Did you mean this patch can be sent separated from this series?
diff mbox series

Patch

diff --git a/po/README b/po/README
index eda7edf4e6..e1a0494b17 100644
--- a/po/README
+++ b/po/README
@@ -344,3 +344,24 @@  Below are the usage examples:
         po-helper.sh check XX.po
 
 Run po-helper.sh without arguments for usage help.
+
+
+Conventions
+-----------
+
+There are some conventions that l10n contributors must follow:
+
+   1. The subject of each commit should be prefixed with `l10n: `.
+   2. The length of commit log title (subject) should be less than 50
+      characters, and the length of other lines (commit log body)
+      should be no more than 72 characters.
+   3. Add "Signed-off-by" trailer to your commit log, like other
+      commits in Git. You can automatically add the trailer by
+      committing with `git commit -s`.
+   4. Check syntax with `msgfmt` or `po-helper.sh check` before
+      committing.
+   5. Squash trivial commits to make history clear.
+   6. Do NOT edit files outside po/ directory.
+   7. Other subsystems ("git-gui", "gitk", and Git itself) have their
+      own workflow. See Documentation/SubmittingPatches if you want
+      to make contributions to these subsystems.