Skip to content

Commit b33eb42

Browse files
committed
Improving the docs of the translation process
1 parent 47937fa commit b33eb42

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

‎translation/README.md‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,28 @@ Please note that this document contains recommendations, aimed at removing barri
1111
## The Translation Principles and Recommendation
1212

1313
- 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.
14-
- 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.
14+
- 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.
1515
- 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.
1616
- 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.
1717

1818
## How to Contribute to the Translation
1919

20-
### How to Improve an Existing Translation
20+
### Improving an Existing Translation
2121

22-
- Please send your Pull Request.
22+
- Please make your changes to the respective `.md` file.
23+
- Once you are ready, send us a Pull Request.
2324

24-
### How to translate new InnerSource Patterns
25+
### Translating a new InnerSource Patterns
2526

2627
- Please copy the file `/patterns/2-structured/<file>.md` to `/translation/<language>/patterns/<file>.md` and start translation.
28+
- Once you are ready, send us a Pull Request.
2729

28-
### How to Start Translating a New Language
30+
### Starting the Translation of a New Language
2931

3032
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.
3133

34+
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.
35+
3236
The translation should begin by creating a `book-<YOUR_LANGUAGE>` branch to work on. Please name the branch after the abbreviation of the language e.g. `book-jp` is used for the Japanese version.
3337

3438
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
4145

4246
### Translation Quality and Review Process
4347

44-
- 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.
48+
We consider it best practice to have **at least one native speaker** review the translation.
49+
50+
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.
4551

4652
### Publishing Translations
4753

48-
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/<YOUR_LANGUAGE>/`, 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.
54+
The books currently available are in English and Japanese.
55+
56+
Trusted Committers in this repository will also be onboarded during the translation process.
57+
58+
When you complete a translation under `/translation/<YOUR_LANGUAGE>/`, 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).

0 commit comments

Comments
 (0)