|
1 | 1 | # Contributing
|
2 | 2 |
|
3 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue,
|
4 |
| -email, or any other method with the owners of this repository before making a change. |
| 4 | +email, or any other method with the owners of this repository before making a change. |
5 | 5 |
|
6 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project.
|
7 | 7 |
|
8 | 8 | ## Pull Request Process
|
9 | 9 |
|
10 |
| -1. We follow a simplified git-flow for our workflow, using `dev`, `staging` and `master` branches |
11 |
| - for development, staging and production site respectively. `dev` branch is used to |
12 |
| - consolidate all the changes from different Pull Request and `staging` branch is for QA before all |
13 |
| - the new changes go live. |
14 |
| -2. Please make your Pull Request to `dev` branch. |
15 |
| -3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you |
| 10 | +1. We follow a simplified git-flow for our workflow, using `dev`, `staging` and `master` branches |
| 11 | + for development, staging and production site respectively. `dev` branch is used to |
| 12 | + consolidate all the changes from different Pull Request and `staging` branch is for QA before all |
| 13 | + the new changes go live. |
| 14 | +2. Please make your Pull Request to `dev` branch. |
| 15 | +3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you |
16 | 16 | do not have permission to do that, you may request the second reviewer to merge it for you.
|
17 | 17 |
|
| 18 | +## Translation Process |
| 19 | + |
| 20 | +1. We use a [spreadsheet in Google Sheets](https://docs.google.com/spreadsheets/d/12_yx09THl9qcBboJvvBwPTY63MfKIIB8WzEDstIOI6s/edit#gid=0) to capture the translation to all supported languages, |
| 21 | + so you should start there. When translating, keep in mind these guidelines: |
| 22 | + * Be mindful that what's entered in the spreadsheet will be displayed on the website as it, |
| 23 | + so do not put any comment/remark in the cells. If you want to add a comment, you can use the |
| 24 | + "insert note" or "comment" functions, which will appear when you right-click the cell. |
| 25 | + * Text that are enclosed with `{}` are just placeholders and must not be translated. They will |
| 26 | + be replaced by actual values (e.g. `{number} new cases` will become `5 new cases` if the number |
| 27 | + of cases is 5). Therefore, do not remove the placeholder in the translation and make sure it's |
| 28 | + part of the translated text. |
| 29 | + * You can use the token in different order if it makes sense in the translated language |
| 30 | + (e.g. for `+{number} new cases`, in some alien language, it reads as `sesac +5 wen`, then you |
| 31 | + can write it as `sesac +{number} wen` ) |
| 32 | + * Currently, translated text doesn't support line breaks, so all the text needs to be in one line |
| 33 | + * If you need to use quote `"`, please prepend it with a backslash `\` (e.g. `\"text\"` instead |
| 34 | + of `"text"` ) |
| 35 | + |
| 36 | +2. If you want to add a new language, please add a new column to the spreadsheet and update the |
| 37 | + translation test with the new locale [here](test/CheckTranslations.spec.js). If you're unsure |
| 38 | + how to do this, then send a message on the #translation Slack channel |
| 39 | + |
| 40 | +3. Our team will regularly run a job to incorporate the translations to the codebase |
| 41 | + |
18 | 42 | ## Code of Conduct
|
19 | 43 |
|
20 | 44 | ### Our Pledge
|
|
0 commit comments