From 78b020d1264e7dcf75b9568ffebee63f3c91d9a1 Mon Sep 17 00:00:00 2001 From: Klaus Sinani Date: Mon, 6 Aug 2018 23:43:35 +0300 Subject: [PATCH] Updated translating process guidelines --- contributing.md | 11 ++++++++++- docs/readme.md | 12 ++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/readme.md diff --git a/contributing.md b/contributing.md index df742698..9d417880 100644 --- a/contributing.md +++ b/contributing.md @@ -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 diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 00000000..79d211a2 --- /dev/null +++ b/docs/readme.md @@ -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! ❤️ +