jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md (#24239)

Browse Source
This commit is contained in:
Matt Pollard
2022-01-12 22:08:11 +01:00
committed by GitHub
parent 78edefdd7c
commit f705a17c1a
2 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -12,11 +12,11 @@ See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how t
We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), 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(Pull Request) 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 pull request for quick fixes like typos, updates, or link fixes.
<img src="./assets/images/contribution_cta.png" width="400"> <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. By this way you can also be a part of Open source contributor's community without even writing a single line of code. 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.
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. 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,7 +33,6 @@ That's how you can easily become a member of the GitHub Documentation community.
## READMEs ## 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: 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/README.md](content/README.md)
- [content/graphql/README.md](content/graphql/README.md) - [content/graphql/README.md](content/graphql/README.md)
@@ -57,7 +56,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). All other code in this repository is licensed under the [MIT license](LICENSE-CODE).
When you are using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
## Thanks :purple_heart: ## Thanks :purple_heart:

7
contributing/localization-checklist.md
View File

@@ -1,15 +1,15 @@
# Localization Prep Checklist # 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).It gives more detail about how to translate by being abide to localization rules. 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 examples that are generic and can be understood by most people. - [ ] Use examples that are generic and can be understood by most people.
- [ ] Avoid controversial examples or culturally specific to a group. - [ ] Avoid controversial examples or culturally specific to a group.
- [ ] Write in active voice. - [ ] Write in active voice.
- [ ] Write simple, short and easy to understand sentences. - [ ] Write simple, short and easy to understand sentences.
- [ ] Avoid using too many pronouns that can make text unclear. - [ ] Avoid using too many pronouns that can make text unclear.
- [ ] Avoid using slang and jokes that might be related to any person,place or gender. - [ ] Avoid using slang and jokes.
- [ ] Avoid negative sentences. - [ ] Avoid negative sentences.
- [ ] Use industry standard acronyms wherever possible and explain custom acronyms. - [ ] Use industry standard acronyms whenever possible and explain custom acronyms.
- [ ] Use indicative mood. - [ ] Use indicative mood.
- [ ] Eliminate redundant and wordy expressions. - [ ] 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. - [ ] Avoid the excessive use of stacked modifiers (noun strings). The translator can misunderstand which one is the noun being modified.
@@ -18,7 +18,6 @@ Use the following checklist to help make your files more translation-friendly. F
- [ ] Avoid using ambiguous modal auxiliary verbs. - [ ] Avoid using ambiguous modal auxiliary verbs.
- [ ] Avoid gender-specific words. - [ ] Avoid gender-specific words.
- [ ] Avoid prepositional phrases. - [ ] Avoid prepositional phrases.
- [ ] Avoid using passive voice to refer the relavant topic.
- [ ] Avoid vague nouns and pronouns (vague sentence subject). - [ ] 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. - [ ] 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.