Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 2.75 KB

Contributing

Welcome to Rustlang book Thai translation project. Contributions to the project are always very welcome! 🙏🏽

Licensing

This repository is under the same license as the official book and Rust itself, MIT/Apache2. You can find the full text of each license in the LICENSE-* files in this repository.

Code of Conduct

The Rust project has a code of conduct that governs all sub-projects, including this one. Please respect it!

Guideline

Have any questions? Feel free to ask in our discussions place. We're here to help!

Translation

  1. Please translate one chapter at a time from top to bottom. Jumping the translation between the context in the same chapter will make the other translator lose the context in the original language around the part that not translate yet.
  2. When do the translation, please change only the texts and keep the style as same as the original version.
  3. Keep transliteration words low, but if you think Thai word to describe that English word is not clear as the original one, you can decide to keep it untouched.
  4. When in doubt, use the existing translation as the guideline.

Submitting a pull request

One PR should contain only one chapter so the reviewer can focus only on that chapter also this will keep PR in a reasonable size to review.

Commit message

For the commit message, use the following format:

<type>::<chapter>::<line_number>::<subject(optional)>

Types are

  • translate :: Translate from the original language to Thai
  • change :: Change incorrect translation which mean the meaning of the translation is going to change
  • fix :: Fix typo in the translation
  • refined :: Refined the word which already in Thai to be smoother to read but didn't change any meaning of it
  • format :: Formatting texts or page
  • add :: Add new page1
  • update :: Update the detail of the page2

1 This can happen when the official repo add new page
2 This can happen when the official repo has change the detail in the page

Chapter

Use the page type (chapter, appendix, forward, etc.) following the number of that kind of page. If there's no number specific for that kind of page, just use page type.

Example

  • For ch03-02-data-types.md use ch03-02
  • For appendix-04-useful-development-tools.md use appendix-04
  • For title-page.md use title-page.md

Subject (optional)

is a short description of what has been done

Example

  • For change chapter appendix-01-keywords.md use change::appendix-01
  • For translate chapter ch08-02-strings.md use translate::ch08-02