Skip to content

Commit

Permalink
Updated translation guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
klaudiosinani committed Jan 3, 2019
1 parent 0978634 commit a1bf8d9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
12 changes: 10 additions & 2 deletions contributing.md
Expand Up @@ -37,11 +37,19 @@ Come over and say hi anytime you feel like on [Gitter](https://gitter.im/klaussi

### Translating Documentation

- Make sure that the document is not already translated in that language.
#### Create a Translation

- 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.
- Add the name of the language to the document as an extension, e.g: `readme.JP.md`
- Place the translated document inside the [`docs`](https://github.com/klaussinani/ao/tree/master/docs) directory.
- Place the translated document inside the [`docs/i18n`](https://github.com/klaussinani/ao/tree/master/docs/i18n) directory.
- Add your github profile and the translated document to the [`index`](https://github.com/klaussinani/ao/tree/master/docs/i18n/readme.md) file.
- Create a Pull Request including the language in the title, e.g: `Readme: Japanese Translation`

#### Improve a Translation

- 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.
- Create a Pull Request that delivers the improvements and include the language in the title, e.g: `Readme: Improvements for the Japanese Translation`

### Submitting an issue

- Search the issue tracker before opening an issue
Expand Down
11 changes: 11 additions & 0 deletions docs/i18n/readme.md
@@ -0,0 +1,11 @@
## Ao Translated Documentation

- [Deutsch - German](https://github.com/klaussinani/ao/blob/master/docs/i18n/readme.GER.md) by [@christophostrzinski](https://github.com/christophostrzinski)

## Contributing

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.

## Thanks

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 comments on commit a1bf8d9

Please sign in to comment.