mirrors
/
system-design-primer
mirror of https://github.com/donnemartin/system-design-primer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md 

A minor help in finding grammatical errors and adding a few descriptions to make it more user-friendly.
pull/191/head
melvinljy96 2018-08-02 14:25:34 +08:00 committed by GitHub
parent 9c4c603b8f
commit 33f6a4ab3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -7,7 +7,7 @@ Contributions are welcome!
## Bug Reports ## Bug Reports
For bug reports or requests [submit an issue](https://github.com/donnemartin/system-design-primer/issues). For bug reports or requests, pls do not hestitate to submit it at [submit an issue](https://github.com/donnemartin/system-design-primer/issues).
## Pull Requests ## Pull Requests
@ -38,7 +38,7 @@ The preferred way to contribute is to fork the
### GitHub Pull Requests Docs ### GitHub Pull Requests Docs
If you are not familiar with pull requests, review the [pull request docs](https://help.github.com/articles/using-pull-requests/). If you are not familiar with pull requests, take your time and review the [pull request docs](https://help.github.com/articles/using-pull-requests/).
## Translations ## Translations
@ -64,9 +64,9 @@ Translations to new languages are always welcome, especially if you can maintain
* To get it started, fork the repo, then submit a PR with the single file README-xx.md added, where xx is the language code. Use standard [IETF language tags](https://www.w3.org/International/articles/language-tags/), i.e. the same as is used by Wikipedia, *not* the code for a single country. These are usually just the two-letter lowercase code, for example, `fr` for French and `uk` for Ukrainian (not `ua`, which is for the country). For languages that have variations, use the shortest tag, such as `zh-Hant`. * To get it started, fork the repo, then submit a PR with the single file README-xx.md added, where xx is the language code. Use standard [IETF language tags](https://www.w3.org/International/articles/language-tags/), i.e. the same as is used by Wikipedia, *not* the code for a single country. These are usually just the two-letter lowercase code, for example, `fr` for French and `uk` for Ukrainian (not `ua`, which is for the country). For languages that have variations, use the shortest tag, such as `zh-Hant`.
* 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. * 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.
* Add links to your translation at the top of every README*.md file. (For consistency, the link should be added in alphabetical order by ISO code, and the anchor text should be in the native language.) * Add links to your translation at the top of every README*.md file. (For consistency, the link should be added in alphabetical order by ISO code, and the anchor text should be in the native language.)
* When done, indicate on the PR that it's ready to be merged into the main repo. * When it is done, indicate on the PR that it's ready to be merged into the main repo.
* Once accepted, your PR will be squashed into a single commit into the `master` branch. * Once your PR is accepted, your PR will be squashed into a single commit into the `master` branch.
### Translation template credits ### Translation template credits
Thanks to [The Art of Command Line](https://github.com/jlevy/the-art-of-command-line) for the translation template. Special thanks to [The Art of Command Line](https://github.com/jlevy/the-art-of-command-line) for the translation template.