Skip to content

Commit

Permalink
Updated translating process guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
klaudiosinani committed Aug 6, 2018
1 parent f4a92b3 commit 78b020d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
11 changes: 10 additions & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,19 @@ Come over and say hi anytime you feel like on [Gitter](https://gitter.im/klauscf

### Translating Documentation

- Ensure that the document is not already translated in your target language.
#### Create a Translation

- Check the [`index`](https://github.com/klauscfhq/taskbook/tree/master/docs/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/klauscfhq/taskbook/tree/master/docs) directory.
- Add your github profile and the translated document to the [`index`](https://github.com/klauscfhq/taskbook/tree/master/docs/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/klauscfhq/taskbook/tree/master/docs/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
12 changes: 12 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Taskbook Translated Documentation

- [简体中文 - Simplified Chinese](https://github.com/klauscfhq/taskbook/blob/master/docs/readme.ZH.md) by [@chinanf-boy](https://github.com/chinanf-boy)

## Contributing

Visit the [contributing guidelines](https://github.com/klauscfhq/taskbook/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 Taskbook available to everyone around the world! ❤️

0 comments on commit 78b020d

Please sign in to comment.