diff --git a/translation/README.md b/translation/README.md index 728aded08..6fd25dbe2 100644 --- a/translation/README.md +++ b/translation/README.md @@ -11,24 +11,28 @@ Please note that this document contains recommendations, aimed at removing barri ## The Translation Principles and Recommendation - The target of the translation are structured patterns. Find them in folder [/patterns/2-structured/](../patterns/2-structured/). Only structured patterns will be published in Gitbook. -- English is recommended for commit messages. If you are merged into a branch, your commit messages will be seen by members all over the world. This will make it easier for global members to find your activities and will also accelerate collaboration. +- English is recommended for commit messages. If your changes are merged, your commit messages will be seen by members all over the world. This will make it easier for global members to find your activities and will also accelerate collaboration. - Regarding Pull Requests and Issues, it is a good idea to use English, at least for the title and the purpose statement in the preface. Contributions in your language and accompanying discussions may be useful for other translation projects in the future. - Each country has its own cultural and historical background and different contexts. There is no need to discuss language-specific nuances and difficult linguistic expressions in English in your review. Especially if it is a local community of several people translating together, please prioritize the ease of translation in that community. ## How to Contribute to the Translation -### How to Improve an Existing Translation +### Improving an Existing Translation -- Please send your Pull Request. +- Please make your changes to the respective `.md` file. +- Once you are ready, send us a Pull Request. -### How to translate new InnerSource Patterns +### Translating a new InnerSource Patterns - Please copy the file `/patterns/2-structured/.md` to `/translation//patterns/.md` and start translation. +- Once you are ready, send us a Pull Request. -### How to Start Translating a New Language +### Starting the Translation of a New Language That is awesome! We welcome your passion. When implementing InnerSource practices in your region, there can be language barriers. There is great value in getting people in your organization to understand InnerSource in their own language. +Before starting a new translation please talk to us in Slack (in the `#innersource-patterns` channel). Alternatively you can also open an issue on this GitHub repo and we can have an async conversation about your translation project. + The translation should begin by creating a `book-` branch to work on. Please name the branch after the abbreviation of the language e.g. `book-jp` is used for the Japanese version. There are a few things you should prepare before starting a translation project. @@ -41,8 +45,14 @@ However, since git does not create empty folders, it is better to create directo ### Translation Quality and Review Process -- There is a best practice to have at least one native speaker review the translation. In particular, for some special terms, such as "Trusted Committer", please review not only for grammatical correctness but also for appropriateness. If you find a term or expression difficult to understand, please don't hesitate to ask. +We consider it best practice to have **at least one native speaker** review the translation. + +In particular, for special terms, such as "Trusted Committer", please review not only for grammatical correctness but also for appropriateness. If you find a term or expression difficult to understand, please don't hesitate to ask. ### Publishing Translations -The books currently available are in English and Japanese. Trusted Committers in this repository will also be onboarded during the translation process. When you complete a translation under `/translation//`, a GitHub Actions pipeline will run to generate the output for publication in the gitbook. The detailed process is described in [/book/README.md](/book/README.md). Please refer to it. +The books currently available are in English and Japanese. + +Trusted Committers in this repository will also be onboarded during the translation process. + +When you complete a translation under `/translation//`, a GitHub Actions pipeline will run to generate the output for publication in the gitbook. The process is described in detail in [/book/README.md](/book/README.md).