docs: proofread All Documentation (all-contributors#571)

silvncr · Berkmann18 · web-flow · commit 2fdeea1fbe17 · 2022-01-11T10:46:36.000-08:00
Co-authored-by: Maximilian Berkmann &lt;maxieberkmann@gmail.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -13,8 +13,8 @@ A clear and concise description of what the bug is.
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+2. Click on '...'
+3. Scroll down to '...'
 4. See error
 
 **Expected behavior**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is. For example, "I'm always frustrated when [...]"
 
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -7,7 +7,7 @@ Current maintainers:
 - [Tyler Benning](https://github.com/tbenning) 
 - [Jeff Wen](https://github.com/sinchang)
 
-See [the github All Contributors Core Team group](https://github.com/orgs/all-contributors/teams/core/members)
+See [the GitHub All Contributors Core Team group](https://github.com/orgs/all-contributors/teams/core/members)
 
 ## Roadmap/Goals
 ### Unite all contributor efforts ✅
@@ -26,7 +26,7 @@ See [the github All Contributors Core Team group](https://github.com/orgs/all-co
 - [x] Switch to .org from .js.org and promote to communities outside JavaScript
 - [ ] Create a video
 - [ ] Improve SEO (see goals)
-- [ ] Add all contributors bot to github marketplace (see goals 250 app installs)
+- [ ] Add all contributors bot to GitHub marketplace (see goals 250 app installs)
 
 
 ## Metrics OKR Period - Open Leaders (Mid Feb 2019 until April 2019)
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@
 
 
 
-This is a specification for recognizing contributors to an open source project in a way that rewards each and every contribution, not just code.
+This is a specification for recognizing contributors to an open-source project in a way that rewards every contribution, not just code.
 
 The basic idea is this:
 
@@ -70,7 +70,7 @@ See the [contributing docs](https://allcontributors.org/docs/en/project/contribu
 
 ## Contributors ✨
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
diff --git a/docs/bot/configuration.md b/docs/bot/configuration.md
@@ -5,7 +5,7 @@ sidebar_label: Configuration
 ---
 
 You can configure the all-contributors bot behaviour by updating the `.all-contributorsrc` JSON file.
-The data used to generate the contributors list will be stored in there, and you
+The data used to generate the contributors list will be stored there, and you
 can configure how you want `@all-contributors` to generate the list.
 
 > You are viewing the 🤖Bot Configuration, which is similar to the [CLI Configuration](../cli/configuration)
diff --git a/docs/bot/installation.md b/docs/bot/installation.md
@@ -18,7 +18,7 @@ sidebar_label: Installation
 
 
 ## 3. Create a `README.md`
-Ensure you have a `README.md` file in the root of the project (it can be empty).
+Ensure you have a `README.md` file at the root of the project (it can be empty).
 
 If you prefer your contributors table in a place other than the `README.md`; After merging your first bot PR, you can move your contributors table,
 see `files` in the [bot configuration](configuration)
diff --git a/docs/bot/usage.md b/docs/bot/usage.md
@@ -25,7 +25,7 @@ The bot will then create a Pull Request to add the contributor, then reply with
 > Your request to the bot doesn't need to be perfect. The bot will use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/master/lib/parse-comment.js) to determine your intent.
 > For example, this will work too:
 >
-> `Jane you are crushing it in documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @all-contributors`
+> `Jane you are crushing it in the documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @all-contributors`
 > 
 > The bot will work best in parsing your comment correctly if you precede the contributor's username with @ as shown above. Otherwise, the bot may not correctly identify the user.
 ## What's next
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
@@ -5,7 +5,7 @@ sidebar_label: Configuration
 ---
 
 You can configure all-contributors by updating the `.all-contributorsrc` JSON file.
-The data used to generate the contributors list will be stored in there, and you
+The data used to generate the contributors list will be stored there, and you
 can configure how you want `all-contributors-cli` to generate the list.
 
 > You are viewing the CLI Configuration, are you looking for the [Bot Configuration](../bot/configuration)?
diff --git a/docs/cli/installation.md b/docs/cli/installation.md
@@ -22,7 +22,7 @@ yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli
 
 Alternatively, Arch Linux users can install the [`all-contributors-cli`](https://aur.archlinux.org/packages/all-contributors-cli) package from the AUR.
 
-> The CLI is node based, if you don't wish to add a node dependency use the [@all-contributors bot 🤖](../bot/overview)
+> The CLI is node-based, if you don't wish to add a node dependency use the [@all-contributors bot 🤖](../bot/overview)
 
 
 ## 2. Init the Project
diff --git a/docs/cli/usage.md b/docs/cli/usage.md
@@ -36,7 +36,7 @@ for a list of valid `contribution` types.
 
 ### `all-contributors check`
 Use `check` to compare contributors from GitHub with the ones credited in your
-`.all-contributorsrc` file, in order to make sure that credit is given where
+`.all-contributorsrc` file, to make sure that credit is given where
 it's due.
 
 > Due to GitHub API restrictions, this command only works for projects with less
@@ -47,26 +47,26 @@ it's due.
 Use `generate` to read the `contributors` list from your `.all-contributorsrc` file
 and update the contributor tables specified by the `files` key.
 
-Please note the command must be able to find the following tags in those files, in order to update the table:
+Please note the command must be able to find the following tags in those files, to update the table:
 ```
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 ```
-Also note that it needs to find the following tags in order to update the badge:
+Also, note that it needs to find the following tags to update the badge:
 ```
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 ```
 
 
 ## GitHub Users
-In some cases you may see the error message `GitHub API rate limit exceeded for xxx`. You may need to set an environment variable named `PRIVATE_TOKEN` in order to circumvent this [GitHub rate limit](https://developer.github.com/v3/rate_limit/).
+In some cases you may see the error message `GitHub API rate limit exceeded for xxx`. You may need to set an environment variable named `PRIVATE_TOKEN` to circumvent this [GitHub rate limit](https://developer.github.com/v3/rate_limit/).
 
-> Private token is your personal access token to authenticate with the GitHub API.
+> Private token is your Personal Access Token (PAT) to authenticate with the GitHub API.
 
 
 ## GitLab Users
-Please note that if you are using a self-hosted gitlab instance,
+Please note that if you are using a self-hosted GitLab instance,
 some commands will need you to set an environment variable named `PRIVATE_TOKEN` first.
 
 > Private token is the personal access token to authenticate with the GitLab API.
diff --git a/docs/overview.md b/docs/overview.md
@@ -12,7 +12,7 @@ sidebar_label: Overview
 
 <a class="github-button" href="https://github.com/all-contributors/all-contributors" data-icon="octicon-star" data-count-href="/all-contributors/all-contributors/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub" >Star</a>
 
-This is a specification for recognizing contributors to an open source project in a way that rewards each and every contribution, not just code.
+This is a specification for recognizing contributors to an open-source project in a way that rewards every contribution, not just code.
 
 The basic idea is this:
 
diff --git a/docs/project/code-of-conduct.md b/docs/project/code-of-conduct.md
@@ -52,7 +52,7 @@ threatening, offensive, or harmful.
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
 representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
+address, posting via an official social media account or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.
 
@@ -62,7 +62,7 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at kent+coc@doddsfamily.us. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
+obligated to maintain confidentiality concerning the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
diff --git a/docs/project/contribute.md b/docs/project/contribute.md
@@ -19,8 +19,8 @@ All the source code is available at [github.com/all-contributors/all-contributor
 We offer new contributor onboarding, if you're interested in taking part in this please comment in the slack channel. 
 
 ## Committing to an all-contributors repo
-We use the [angular commit convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for commits which is used for an automated changelog generation, so it would be advisable to respect that.
-If you're not used to it or are afraid to mis-type a commit, you can run `npm run commit` or `git cz` (if you have installed `commitizen`) which would take you through a few questions and write the commit for you.
+We use the [angular commit convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for commits that are used for an automated changelog generation, so it would be advisable to respect that.
+If you're not used to it or are afraid to mistype a commit, you can run `npm run commit` or `git cz` (if you have installed `commitizen`) which would take you through a few questions and write the commit for you.
 
 ## Editing Content
 
@@ -38,7 +38,7 @@ Once on a file, click the 'pencil' icon to [easily edit the file inline](https:/
 Our translations are managed through crowdin. You can help contribute by heading to [the crowdin project] and suggesting translations.
 If you like, [comment on this issue](https://github.com/all-contributors/all-contributors/issues/143) to let us know you're helping or if you have any queries!
 
-> When translating, it's important that anything that has the [XPATH](https://developer.mozilla.org/en-US/docs/Web/XPath) `@href`, `@src` etc should not be translated. Things like `code` should not be either. This will cause the project to 404. See below image for an example:
+> When translating, anything that has the [XPATH](https://developer.mozilla.org/en-US/docs/Web/XPath) `@href`, `@src` etc mustn't be translated. Things like `code` should not be either. This will cause the project to 404. See the below image for an example:
 <img src="../../assets/translating-xpath.png" alt="Contribute to translating" />
 
 > However, it's recommended to translate any content that would contribute to a better comprehension like the comments in `code` tags _as long as_ it doesn't change the actual code since it only understands English.
@@ -56,7 +56,7 @@ If you like, [comment on this issue](https://github.com/all-contributors/all-con
 5. For **proofreaders** only: You can either approve translation suggestions (whether it's done by you or someone else), which you will find in the _"[LANGUAGE] TRANSLATIONS"_ section, by clicking on the :ballot_box_with_check: or delete them by clicking on the :wastebasket: icon.
 
 ### Change deployments
-After you translate strings in any given languages, you won't see those changes appearing live until the `master` branch was updated followed by a successful deployment.
+After you translate strings in any given language, you won't see those changes appearing live until the `master` branch was updated followed by a successful deployment.
 
 ## Search
 Search is by algolia, the configuration is at https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json
@@ -73,4 +73,4 @@ To get started locally:
 ## Add yourself as a contributor
 To add yourself to the table of contributors, follow the [bot usage instructions](../bot/usage) ;).
 
-[the crowdin project]: https://crowdin.com/project/all-contributors
+[the crowdin project]: https://crowdin.com/project/all-contributors
diff --git a/docs/project/implementations.md b/docs/project/implementations.md
@@ -4,37 +4,38 @@ title: Who's using it?
 sidebar_label: Who's using it?
 ---
 
-This is a list of projects which have implemented the `all-contributors` specification. To add your project to this
+This is an alphabetical list of projects which have implemented the `all-contributors` specification. To add your project to this
 list, please [edit this page](contribute)!
 
+- [all-contributors/all-contributors-cli](https://github.com/all-contributors/all-contributors-cli)
 - [all-contributors/all-contributors](https://github.com/all-contributors/all-contributors)
-- [sarbbottam/eslint-find-rules](https://github.com/sarbbottam/eslint-find-rules)
-- [platinumazure/eslint-plugin-qunit](https://github.com/platinumazure/eslint-plugin-qunit)
-- [kentcdodds/webpack-config-utils](https://github.com/kentcdodds/webpack-config-utils)
+- [cesar-richard/heimdal](https://github.com/cesar-richard/heimdal)
+- [gatewayapps/kamino](https://github.com/gatewayapps/kamino)
+- [gitcoinco/code_fund_ads](https://github.com/gitcoinco/code_fund_ads)
+- [GitPoint](https://github.com/gitpoint/git-point)
+- [ioof-holdings/redux-subspace](https://github.com/ioof-holdings/redux-subspace)
+- [ivanpaulovich/clean-architecture-manga](https://github.com/ivanpaulovich/clean-architecture-manga)
+- [jakewies/hugo-theme-codex](https://github.com/jakewies/hugo-theme-codex)
+- [jccguimaraes/atom-project-viewer](https://github.com/jccguimaraes/atom-project-viewer)
+- [jmeas/redux-resource](https://github.com/jmeas/redux-resource)
 - [kentcdodds/p-s](https://github.com/kentcdodds/p-s)
-- [kentcdodds/split-guide](https://github.com/kentcdodds/split-guide)
-- [all-contributors/all-contributors-cli](https://github.com/all-contributors/all-contributors-cli)
 - [kentcdodds/react-workshop](https://github.com/kentcdodds/react-workshop)
 - [kentcdodds/rtl-css-js](https://github.com/kentcdodds/rtl-css-js)
-- [ta2edchimp/opt-cli](https://github.com/ta2edchimp/opt-cli)
-- [jccguimaraes/atom-project-viewer](https://github.com/jccguimaraes/atom-project-viewer)
+- [kentcdodds/split-guide](https://github.com/kentcdodds/split-guide)
+- [kentcdodds/webpack-config-utils](https://github.com/kentcdodds/webpack-config-utils)
+- [olavoparno/jest-badges-readme](https://github.com/olavoparno/jest-badges-readme)
+- [OperationCode/front-end](https://github.com/OperationCode/front-end)
+- [persian-tools/persian-tools](https://github.com/persian-tools/persian-tools)
+- [platinumazure/eslint-plugin-qunit](https://github.com/platinumazure/eslint-plugin-qunit)
+- [Pokemon-PythonRed](https://github.com/Pokemon-PythonRed/Pokemon-PythonRed)
 - [React Medellin Meetup](https://github.com/react-medellin/meetup)
-- [jmeas/redux-resource](https://github.com/jmeas/redux-resource)
 - [render_async](https://github.com/renderedtext/render_async)
-- [GitPoint](https://github.com/gitpoint/git-point)
-- [ioof-holdings/redux-subspace](https://github.com/ioof-holdings/redux-subspace)
-- [syt123450/giojs](https://github.com/syt123450/giojs)
-- [olavoparno/jest-badges-readme](https://github.com/olavoparno/jest-badges-readme)
-- [gatewayapps/kamino](https://github.com/gatewayapps/kamino)
+- [sarbbottam/eslint-find-rules](https://github.com/sarbbottam/eslint-find-rules)
 - [sxwjs/sxwjs](https://github.com/sxwjs/sxwjs)
-- [OperationCode/front-end](https://github.com/OperationCode/front-end)
-- [cesar-richard/heimdal](https://github.com/cesar-richard/heimdal)
-- [gitcoinco/code_fund_ads](https://github.com/gitcoinco/code_fund_ads)
+- [syt123450/giojs](https://github.com/syt123450/giojs)
 - [sytespace/Native](https://github.com/sytespace/Native)
-- [ivanpaulovich/clean-architecture-manga](https://github.com/ivanpaulovich/clean-architecture-manga)
+- [ta2edchimp/opt-cli](https://github.com/ta2edchimp/opt-cli)
 - [tstrohmeier/docker-spark-development](https://github.com/tstrohmeier/docker-spark-development)
-- [jakewies/hugo-theme-codex](https://github.com/jakewies/hugo-theme-codex)
-- [persian-tools/persian-tools](https://github.com/persian-tools/persian-tools)
 
 **Note**: There are many projects not listed here. You'll probably be able to find more with this
 [github search for .all-contributorsrc](https://github.com/search?utf8=%E2%9C%93&q=.all-contributorsrc+in%3Apath&type=Code&ref=searchresults)
diff --git a/docs/specification.md b/docs/specification.md
diff --git a/docs/tooling.md b/docs/tooling.md

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ The bot will then create a Pull Request to add the contributor, then reply with`
`25`	`25`	`> Your request to the bot doesn't need to be perfect. The bot will use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/master/lib/parse-comment.js) to determine your intent.`
`26`	`26`	`> For example, this will work too:`
`27`	`27`	`>`
`28`		-> `Jane you are crushing it in documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @all-contributors`
	`28`	+> `Jane you are crushing it in the documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @all-contributors`
`29`	`29`	`>`
`30`	`30`	`> The bot will work best in parsing your comment correctly if you precede the contributor's username with @ as shown above. Otherwise, the bot may not correctly identify the user.`
`31`	`31`	`## What's next`