зеркало из https://github.com/github/docs.git
Коммит
c37909ef2d
|
@ -12,11 +12,11 @@ See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how t
|
|||
|
||||
We accept different [types of contributions](CONTRIBUTING.md/#types-of-contributions-memo), including some that don't require you to write a single line of code.
|
||||
|
||||
On the GitHub Docs site, you can click the make a contribution button to open a PR for quick fixes like typos, updates, or link fixes.
|
||||
On the GitHub Docs site, you can click the make a contribution button to open a PR(Pull Request) for quick fixes like typos, updates, or link fixes.
|
||||
|
||||
<img src="./assets/images/contribution_cta.png" width="400">
|
||||
|
||||
For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see.
|
||||
For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. By this way you can also be a part of Open source contributor's community without even writing a single line of code.
|
||||
|
||||
If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions.
|
||||
|
||||
|
@ -33,6 +33,7 @@ That's how you can easily become a member of the GitHub Documentation community.
|
|||
## READMEs
|
||||
|
||||
In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:
|
||||
YOu can go through among them for specified details regarding the topics listed below.
|
||||
|
||||
- [content/README.md](content/README.md)
|
||||
- [content/graphql/README.md](content/graphql/README.md)
|
||||
|
@ -56,7 +57,7 @@ The GitHub product documentation in the assets, content, and data folders are li
|
|||
|
||||
All other code in this repository is licensed under the [MIT license](LICENSE-CODE).
|
||||
|
||||
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
|
||||
When you are using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
|
||||
|
||||
## Thanks :purple_heart:
|
||||
|
||||
|
|
|
@ -1,15 +1,15 @@
|
|||
# Localization Prep Checklist
|
||||
|
||||
Use the following checklist to help make your files more translation-friendly. For additional information, refer to the [style guide](content-style-guide.md).
|
||||
Use the following checklist to help make your files more translation-friendly. For additional information, refer to the [style guide](content-style-guide.md).It gives more detail about how to translate by being abide to localization rules.
|
||||
|
||||
- [ ] Use examples that are generic and can be understood by most people.
|
||||
- [ ] Avoid controversial examples or culturally specific to a group.
|
||||
- [ ] Write in active voice.
|
||||
- [ ] Write simple, short and easy to understand sentences.
|
||||
- [ ] Avoid using too many pronouns that can make text unclear.
|
||||
- [ ] Avoid slang and jokes.
|
||||
- [ ] Avoid using slang and jokes that might be related to any person,place or gender.
|
||||
- [ ] Avoid negative sentences.
|
||||
- [ ] Use industry standard acronyms whenever possible and explain custom acronyms.
|
||||
- [ ] Use industry standard acronyms wherever possible and explain custom acronyms.
|
||||
- [ ] Use indicative mood.
|
||||
- [ ] Eliminate redundant and wordy expressions.
|
||||
- [ ] Avoid the excessive use of stacked modifiers (noun strings). The translator can misunderstand which one is the noun being modified.
|
||||
|
@ -18,6 +18,7 @@ Use the following checklist to help make your files more translation-friendly. F
|
|||
- [ ] Avoid using ambiguous modal auxiliary verbs.
|
||||
- [ ] Avoid gender-specific words.
|
||||
- [ ] Avoid prepositional phrases.
|
||||
- [ ] Avoid using passive voice to refer the relavant topic.
|
||||
- [ ] Avoid vague nouns and pronouns (vague sentence subject).
|
||||
- [ ] Keep inline links to a minimum. If they are necessary, preface them with a phrase such as "For more information, see "Link title". Alternatively, add relevant links to a "Further reading" section at the end of the topic.
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче