Skip to content

Commit a1bf8d9

Browse files
committed
Updated translation guidelines
1 parent 0978634 commit a1bf8d9

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

contributing.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,19 @@ Come over and say hi anytime you feel like on [Gitter](https://gitter.im/klaussi
3737

3838
### Translating Documentation
3939

40-
- Make sure that the document is not already translated in that language.
40+
#### Create a Translation
41+
42+
- Check the [`index`](https://github.com/klaussinani/ao/tree/master/docs/i18n/readme.md) file to ensure that the document is not already translated in your target language.
4143
- Add the name of the language to the document as an extension, e.g: `readme.JP.md`
42-
- Place the translated document inside the [`docs`](https://github.com/klaussinani/ao/tree/master/docs) directory.
44+
- Place the translated document inside the [`docs/i18n`](https://github.com/klaussinani/ao/tree/master/docs/i18n) directory.
45+
- Add your github profile and the translated document to the [`index`](https://github.com/klaussinani/ao/tree/master/docs/i18n/readme.md) file.
4346
- Create a Pull Request including the language in the title, e.g: `Readme: Japanese Translation`
4447

48+
#### Improve a Translation
49+
50+
- Include your github profile next to the translation you improved at the [`index`](https://github.com/klaussinani/ao/tree/master/docs/i18n/readme.md) file.
51+
- Create a Pull Request that delivers the improvements and include the language in the title, e.g: `Readme: Improvements for the Japanese Translation`
52+
4553
### Submitting an issue
4654

4755
- Search the issue tracker before opening an issue

docs/i18n/readme.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Ao Translated Documentation
2+
3+
- [Deutsch - German](https://github.com/klaussinani/ao/blob/master/docs/i18n/readme.GER.md) by [@christophostrzinski](https://github.com/christophostrzinski)
4+
5+
## Contributing
6+
7+
Visit the [contributing guidelines](https://github.com/klaussinani/ao/blob/master/contributing.md#translating-documentation) to learn more on how to get involved in the translating process.
8+
9+
## Thanks
10+
11+
Tons of thank you to the amazing people that help out with the creation and maintenance of the translations! Your contributions make Ao available to everyone around the world!

0 commit comments

Comments
 (0)