KumiSystems/Chatwoot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: Add documentation on translation process (#1424)

Browse source
This commit is contained in:
Pranav Raj S 2020-11-18 15:27:50 +05:30 committed by GitHub
parent c40ba0d3dd
commit 29bd05ccfb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 51 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -32,7 +32,7 @@ Now, a failed project is back on track and the prospects are looking great. The
### Features
Chatwoot gives an integrated view of conversations happening in different communication channels.
Chatwoot gives an integrated view of conversations happening in different communication channels.
It supports the following conversation channels:
@ -44,7 +44,7 @@ It supports the following conversation channels:
- **API Channel**: Build custom communication channels using our API channel.
- **Email (beta)**: Forward all your email queries to Chatwoot and view it in our integrated dashboard.
Other features include:
Other features include:
- **Multi-brand inboxes**: Manage multiple brands or pages using a single dashboard.
- **Private notes**: Inter team communication is possible using private notes in a conversation.
@ -62,12 +62,16 @@ Other features include:
Detailed documentation is available at [www.chatwoot.com/help-center](https://www.chatwoot.com/help-center).
### Translation process
The translation process for Chatwoot web and mobile app is managed at [https://translate.chatwoot.com](https://translate.chatwoot.com) using Crowdin. Please read the [translation guide](https://www.chatwoot/docs/contributing/translating-chatwoot-to-your-language) for contributing to Chatwoot.
---
### Branching model
We use the [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The base branch is `develop`.
If you are looking for a stable version, please use the `master` or tags labelled as `v1.x.x`.
If you are looking for a stable version, please use the `master` or tags labelled as `v1.x.x`.
---

22
docs/contributing.md
View file

@ -19,15 +19,15 @@ Thank you for taking an interest in contributing to Chatwoot. Before submitting
- It's okay and encouraged to have multiple small commits as you work on the PR - we will squash the commits before merging.
### Getting Started
### Getting Started
- Before starting your work, ensure an [issue](https://github.com/chatwoot/chatwoot/issues) exist for it. If not feel free to create one.
- Add a comment on the issue and wait for the issue to be assigned before you start working on it.
- This helps to avoid multiple people working on similar issues.
- If the solution is complex, propose the solution on the issue and wait for one of the core contributors to approve before going into the implementation.
- Add a comment on the issue and wait for the issue to be assigned before you start working on it.
- This helps to avoid multiple people working on similar issues.
- If the solution is complex, propose the solution on the issue and wait for one of the core contributors to approve before going into the implementation.
- This helps in shorter turn around times in merging PRs
- For new feature requests, Provide a convincing reason to add this feature. Real-life business use-cases will be super helpful.
- Feel free to join our [discord community](https://discord.gg/cJXdrwS), if you need further discussions with the core team.
- For new feature requests, Provide a convincing reason to add this feature. Real-life business use-cases will be super helpful.
- Feel free to join our [discord community](https://discord.gg/cJXdrwS), if you need further discussions with the core team.
### Developing a new feature:
@ -38,9 +38,7 @@ Thank you for taking an interest in contributing to Chatwoot. Before submitting
- If you are resolving a particular issue, add `Bug: Fix xxxx` (#xxxx is the issue) in your PR title.
- Provide a detailed description of the bug in the PR.
- Add appropriate test coverage if applicable.
### Translations:
- When you are introducing new text copies, you only need to worry about making changes to english language files.
- We accept language translations / updates for existing translations through [crowdin](https://translate.chatwoot.com/)
- If a language doesn't exist in our crowdin, please feel free to create an [issue](https://github.com/chatwoot/chatwoot/issues) to get it enabled.
### Translations
For language translations, please read the guide [translating Chatwoot to your language](/docs/contributing/translating-chatwoot-to-your-language)

34
docs/contributing/translating-chatwoot-to-your-language.md Normal file
View file

@ -0,0 +1,34 @@
---
path: "/docs/contributing/translating-chatwoot-to-your-language"
title: "Translate Chatwoot to your language"
---
Chatwoot uses American English by default. Each and every string available in Chatwoot can be translated to the language of your choice. Chatwoot uses Crowdin to manage the translation process. The updates from Crowdin is also included along with every release.
### How do I see the strings that needs to be translated?
In the codebase the string are placed in the following locations.
- `app/javascript/dashboard/i18n` - The strings related to the agent dashboard
- `app/javascript/widget/i18n` - The strings related to the web widget
- `config/locales` - The strings used in backend messages or API response.
Alternatively, you can login to the **Crowdin** ([https://translate.chatwoot.com](https://translate.chatwoot.com)) and create an account to view the strings that needs to be translated.
### How to contribute?
If you don't find your language on Crowdin, please create an issue on [Github](https://github.com/chatwoot/chatwoot/issues) to add the language.
#### Translate Strings
The translation process for Chatwoot web and mobile app is managed at [https://translate.chatwoot.com](https://translate.chatwoot.com) using Crowdin. You will have to create an account at Crowdin before you can select a language and contribute.
#### Proofreading
Proofreading helps ensure the accuracy and consistency of translations. Right now, the translations are being accepted without a proof reading step. This would be changed in the future as an when there are more contributors on each language.
*Note:* If you are the only person contributing to a language, make sure that you inform any of the Chatwoot members to gain access to manage the language.
#### Releasing a new language
All the translated strings would be included in the next release. If a language has *60% or more translated strings* in Crowdin, we would enable the language in Chatwoot app during the next release.