Skip to content

Commit f465db3

Browse files
yuhattorspier
andcommitted
Apply suggestions for translation README.md
Co-authored-by: Sebastian Spier <github@spier.hu>
1 parent cec5123 commit f465db3

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

‎translation/README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# Translation Process and Recommendations
22

33
If you would like to contribute to the InnerSource Patterns translation, great! We would love to work with you!
4+
45
First, please refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for basic contribution instructions.
5-
This document covers basic translation principles, how you can contribute, and the review process. Please note that the content of this document is recommendations, mainly aimed at removing barriers for new contributors to the translation process. If you see something missing, please feel free to make suggestions.
6+
7+
This document covers basic translation principles, how you can contribute, and the review process.
8+
9+
Please note that this document contains recommendations, aimed at removing barriers for new contributors to the translation process. If you see something missing, please feel free to make suggestions.
610

711
## The Translation Principles and Recommendation
812

9-
- The target of the translation is structured patterns. You can find them at ```/patterns/2-structured/```, and only structured patterns are available in Gitbook.
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.
1014
- 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.
1115
- 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.
1216
- 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.
@@ -19,7 +23,7 @@ This document covers basic translation principles, how you can contribute, and t
1923

2024
### How to translate new InnerSource Patterns
2125

22-
- Please copy the file ```/patterns/2-structured/<file>.md``` to ```/translation/<language>/patterns/<file>.md``` and start translation.
26+
- Please copy the file `/patterns/2-structured/<file>.md` to `/translation/<language>/patterns/<file>.md` and start translation.
2327

2428
### How to Start Translating a New Language
2529

0 commit comments

Comments
 (0)