github
/
the-art-of-command-line
mirror of https://github.com/jlevy/the-art-of-command-line
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #338 from francescomalatesta/contrib-guidelines 

Contrib guidelines
pull/336/head
Joshua Levy 2016-01-07 07:40:20 -08:00
parent 2cf2f46789 5dbe213e3e
commit 89082ad7a0
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -10,7 +10,7 @@ Here are few notes before you jump in.
### Style
- Stay close to the existing style of the document when possible.
- Remember to focus on brevity, specificity, and utility.
- Remember to focus on **brevity**, **specificity**, and **utility**.
- Avoid long explanations and instead prefer links to resources.
### Using issues and PRs
@ -27,19 +27,20 @@ Maintaining the guide in several languages is a little confusing, so here is the
- Each translation has a maintainer to update the translation as the original evolves and to review others' changes. This doesn't require a lot of time, but review by the maintainer is important to maintain quality.
- See the [AUTHORS.md](AUTHORS.md) file for current maintainers. (This file is generated from the [authors-info.yml](admin/authors-info.yml) file.)
Changes to translations:
### Changes to translations
- Changes to content should be made to the English version first, and then translated to each other language.
- Changes that improve translations should be made directly on the file for that language. PRs should only modify one language at a time.
- Submit a PR with changes to the file in that language. Each language has a maintainer, who reviews changes in that language. Then the primary maintainer @jlevy merges it in.
- Prefix PRs and issues with language codes if they are for that translation only, e.g. "es: Improve grammar", so maintainers can find them easily.
Adding translations to new languages:
### Adding translations to new languages
- Translations to new languages are always welcome, especially if you can maintain the translation!
Translations to new languages are always welcome, especially if you can maintain the translation!
- To get it started, fork the repo, then submit a PR with the single file README-xx.md added, where xx is the lowercase language code. (Use standard two-letter ISO language codes, i.e. the same as is used by Wikipedia, not the code for a single country.)
- If there is not an issue for your language, file one so people know you are working on it and we can arrange. Confirm you are native level in the language and are willing to maintain the translation, so it's not orphaned.
- If the translation is in progress but stalled, offer to help.
- To get it started, fork the repo, then submit a PR with the single file README-xx.md added, where xx is the lowercase language code. (Use standard two-letter ISO language codes, i.e. the same as is used by Wikipedia, not the code for a single country.)
- Invite friends to review if possible. If desired, feel free to invite friends to help your original translation by letting them fork your repo, then merging their PRs.
- When done, indicate on the PR that it's ready to be merged into the main repo.