Skip to content

Commit

Permalink
feat: adding translation rules to README (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
CBID2 authored Oct 19, 2023
1 parent cfe3bc2 commit 32a0743
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 24 additions & 0 deletions i18tn-guidelines.md
Original file line number Diff line number Diff line change
@@ -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.)

0 comments on commit 32a0743

Please sign in to comment.