Commit f11dd360 authored by Ulrike Uhlig's avatar Ulrike Uhlig
Browse files

Update translator's documentation to mention the pre-commit hook

parent 75a6604b
......@@ -133,7 +133,14 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad
git config --list
4. **Create a branch**
4. **Install the pre-commit hook**
There is a script in ./bin/pre-commit-translation that can be used as
a pre-commit hook. Please set it up as documented in the comments on
top of that file. It will run some sanity checks on the translated
files.
5. **Create a branch**
Create a branch for every translation you make, for example, if you want to
translate the "contribute" page, create a branch named `translate/contribute`:
......@@ -146,25 +153,25 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad
master
* translate/contribute
5. **Translate!**
6. **Translate!**
You can use your preferred PO file editor, for example, *Poedit* which is included in Tails.
6. **Save your translations**
7. **Save your translations**
Add your changes, then commit
git add -p
git commit
7. **Test your work**
8. **Test your work**
[[Build the website locally|contribute/build/website/]] in order to verify
your modifications or to review the translations of somebody else.
If you need to rework something, go back to step 5, translate, and test again.
8. **Merge our main repository into yours**.
9. **Merge our main repository into yours**.
Regularly, pull from the `master` branch of the main repository to update
your local files.
......@@ -173,7 +180,7 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad
`git pull origin master` fetches and merges the files.
9. **Publish your modifications**
10. **Publish your modifications**
Push your changes to your online Git repository:
......@@ -183,12 +190,12 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad
git push myrepo translate/contribute
10. Ask other members of your translation team to review your work by writing
11. Ask other members of your translation team to review your work by writing
an email to [[the mailing list for
translators|translate#follow-up]], containing in its subject
"(Review)" and the short code for the translated language, for example "[fr]".
11. The reviewer, once happy with the result, should ask on the
12. The reviewer, once happy with the result, should ask on the
[[mailing list for translators|translate#follow-up]] to pull from
the branch that was worked on, writing an email with "(pull)" and the language
short code in the subject. Ideally, such email would be signed with OpenPGP.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment