diff --git a/README.md b/README.md index 2251b80..df6ec59 100644 --- a/README.md +++ b/README.md @@ -118,6 +118,8 @@ You can add this contribution to your [OpenSauced](https://opensauced.pizza) res ## šŸ¤ Contributing All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please follow the Readme directions for contributing. +- **Translations:** If you want to translate the README and other necessary parts of this repo, check out our community guidelines. + ## Contributors diff --git a/i18tn-guidelines.md b/i18tn-guidelines.md new file mode 100644 index 0000000..08a4ae4 --- /dev/null +++ b/i18tn-guidelines.md @@ -0,0 +1,24 @@ +# šŸŒ i18tn Guide + +At the moment, we have the course in the following languages: + +* Brazilian Portuguese +* English +* French + +## How can I contribute? + +* **Translate our README**. There are two methods of translation contributions we accept. + * **Official Translations**: Official translations start as a post in our discussion board. If there is enough interest and volunteers, we can add the official translation as an option to view within our README. + * **Community Translations**: We canā€™t always support the maintenance of translations. However, we do know that there are contributors out there willing to translate. For that reason, we have our Community Translations section. If youā€™ve forked the repository and created a translation, you can add a link to your forked translation to `community-translations.md`. We encourage you to also add it to the discussion board in the event it becomes popular enough and has enough support to be moved to an official translation. +* **Review PRs and translations.** New to reviewing GitHub PRs and translations? No worries, we have you covered in our [Reviewer Process Guide](#reviewer-process-guide). + +## Reviewer Process Guide + +When it comes to reviewing a translation pull request (PR), ask yourself the following questions: + +* Does the current translation match the instructions in the English version? +* Are there links that could be localized? (e.g. Wikipedia and MDN links) +* Is the translation correctly written following the translated language's norms and practices? + +When you think a PR is ready to be merged after your suggestions were addressed (if any), approve it through GitHub's "Review Changes" button or leave an "LGTM!" in the comment section and tag one of the maintainers. (ā€œLGTMā€ is an abbreviation of ā€œLooks Good to Meā€ or ā€œLetā€™s Get to Mergingā€, often used to approve pull requests.)