You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit b33eb42
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: translation/README.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,24 +11,28 @@ Please note that this document contains recommendations, aimed at removing barri
11
11
## The Translation Principles and Recommendation
12
12
13
13
- 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.
15
15
- 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.
16
16
- 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.
17
17
18
18
## How to Contribute to the Translation
19
19
20
-
### How to Improve an Existing Translation
20
+
### Improving an Existing Translation
21
21
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.
23
24
24
-
### How to translate new InnerSource Patterns
25
+
### Translating a new InnerSource Patterns
25
26
26
27
- 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.
27
29
28
-
### How to Start Translating a New Language
30
+
### Starting the Translation of a New Language
29
31
30
32
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.
31
33
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
+
32
36
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.
33
37
34
38
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
41
45
42
46
### Translation Quality and Review Process
43
47
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.
45
51
46
52
### Publishing Translations
47
53
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