Skip to content

Commit 83d2537

Browse files
authored
Translation instructions (InnerSourceCommons#257)
* Document translations * Update CONTRIBUTING.md
1 parent a2d1444 commit 83d2537

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
Thanks for contributing. A few tips:
22

3+
# Translations
4+
5+
* All articles may be translated into any language of interest.
6+
* Translated articles should be storied next to the English articles in a subfolder named as the [two-character language code](https://www.loc.gov/standards/iso639-2/php/code_list.php) of the translation (e.g. the `de` subfolder for German).
7+
* The filename of the article should be translated as well.
8+
* Issues tracking translations on the [project board](https://github.com/InnerSourceCommons/InnerSourceLearningPath/projects/1) should be labeled with the `Translations` tag as well as the tag of the section being translated (e.g. `Contributor`).
9+
Here is [an example](https://github.com/InnerSourceCommons/InnerSourceLearningPath/issues/255).
10+
* Here is the [status of translation efforts](https://github.com/InnerSourceCommons/InnerSourceLearningPath/wiki/Translations).
11+
* Other mechanics of working on translations follow the guidelines below that apply to any file in the `InnerSourceLearningPath`.
12+
313
# Files
414

515
* When submitting new files, follow the folder structure listed under **Repository Setup** in [the README](./README.md).

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ section-name/0n-last-topic-article.asciidoc
6868
section-name/0n-last-topic-script.asciidoc
6969
section-name/0n-last-topic-workbook.asciidoc
7070
. . .
71+
section-name/de // Contains translations of the articles to German
72+
section-name/zh // Contains translations of the articles to Chinese
73+
section-name/ll // Contains translations of the articles to the two-letter language code
74+
. . .
7175
workbook/0n-section-name.asciidoc // Contains the part of the workbook matching the section's name.
7276
```
7377

0 commit comments

Comments
 (0)