awesome/the-art-of-command-line
1
0
Fork 0
mirror of https://github.com/jlevy/the-art-of-command-line.git synced 2024-12-04 10:24:46 +02:00
Code

Tweaks to contributing guidelines.

Browse Source
This commit is contained in:
Joshua Levy 2016-01-07 07:42:47 -08:00
parent 89082ad7a0
commit d2f2652dd6
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -15,9 +15,9 @@ Here are few notes before you jump in.
### Using issues and PRs
- Please *create and comment on issues freely* to discuss. A lot of the difficulty in accepting PRs is around style and format, and whether changes should be made at all, so rationale or explanations for the change are useful.
- Please *review open issues and pull requests* before submitting a new one, to help reduce duplication.
- To the extent possible, *break up changes into multiple PRs* so they can be approved separately. Large contributions are also welcome, but are harder and slower to approve, as they tend to require discussion or rewriting.
- Please **create and comment on issues freely** to discuss. A lot of the difficulty in accepting PRs is around style and format, and whether changes should be made at all, so rationale or explanations for the change are useful.
- Please **review open issues and pull requests** before submitting a new one, to help reduce duplication.
- To the extent possible, **break up changes into multiple PRs** so they can be approved separately. Large contributions are also welcome, but are harder and slower to approve, as they tend to require discussion or rewriting.
## Translations
@ -38,9 +38,9 @@ Maintaining the guide in several languages is a little confusing, so here is the
Translations to new languages are always welcome, especially if you can maintain the translation!
- Check existing issues to see if a translation is in progress or stalled. If so, offer to help.
- If it is not in progress, file an issue for your language 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.
- 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.
- 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.