Skip to content

feat: added translation contribution guide #1393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 18, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ Topics that are around understanding something can be written as a blog post (we

## Translations (i18n)

While we plan to support translations in the future, we are not currently accepting them until Tauri 2.0 is a bit more stable.
Thanks for your interest in helping to translate the documents! While we plan to support translations in the future, **we are not currently accepting them until Tauri 2.0 is a bit more stable**.

Once translations are enabled you can check the [translation status page](https://beta.tauri.app/contribute/translate-status).

See [Translations](./TRANSLATING.md) for more information.
33 changes: 33 additions & 0 deletions .github/TRANSLATING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Translations (i18n)

Thanks for your interest in helping to translate the documents! While we plan to support translations in the future, **we are not currently accepting them until Tauri 2.0 is a bit more stable**.

Once translations are enabled you can check the [translation status page](https://beta.tauri.app/contribute/translate-status).

To ensure the translation is consistent across multiple contributions, be sure to [communicate with others contributors in the `#docs` channel on Discord](https://discord.com/invite/tauri) and consult with reliable external resources such as [Microsoft terminology search](https://msit.powerbi.com/view?r=eyJrIjoiODJmYjU4Y2YtM2M0ZC00YzYxLWE1YTktNzFjYmYxNTAxNjQ0IiwidCI6IjcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0NyIsImMiOjV9) during translation.

### Enabling a Language

If you seek to contribute but find your language missing, please open an issue.

### Starting a Translation

Before you start working on a translation, look through the [open pull requests](https://beta.tauri.app/contribute/translate-status#needs-review) to see if anyone else is already working on one for your language.

If none spotted, then now is time for you to lead the effort! So here's how to start:

1. Head to [translation status page](https://beta.tauri.app/contribute/translate-status).
2. Look for missing translation in corresponding languages.
3. Hit `Create page +` which will help you automagically fork the repository and create the corresponding page.
4. Once your translation is done, initiate a pull request.

Note that you may send send a pull request before your translation is complete: e.g., you may want to ask for help with translations. However, your pull request will not be merged until the translation is complete.

### Updating a Translation

#### Corrections

If you notice spelling or grammar errors, typos, or opportunities for better phrasing, open a pull request with your suggested fix. If you see a problem that you aren't sure of or don't have time to fix, open an issue.

#### Broken Links
When broken links are found, try to fix them across all translations. Ideally, only update the linked URLs, so that translation changes will definitely not be necessary.