docs: correct grammar and typos (#3775)

phil-davis · web-flow · commit 19e30bd2d17e · 2023-11-16T08:25:49.000+01:00
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@
 ## Contents
 
 - [What is commitlint](#what-is-commitlint)
-  - [Benefits using commitlint](#benefits-using-commitlint)
+  - [Benefits of using commitlint](#benefits-using-commitlint)
 - [Getting started](#getting-started)
 - [CLI](#cli)
 - [Config](#config)
@@ -76,7 +76,7 @@ Common types according to [commitlint-config-conventional (based on the Angular
 
 These can be modified by [your own configuration](#config).
 
-### Benefits using commitlint
+### Benefits of using commitlint
 
 - [Why Use Conventional Commits?](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits)
 - ["The perks of committing with conventions" (Talk slides)](https://slides.com/marionebl/the-perks-of-committing-with-conventions#/)
@@ -191,7 +191,7 @@ Check the [main website](https://commitlint.js.org/).
 
 ## Roadmap
 
-`commitlint` is considered stable and is used in various projects as development tool.
+`commitlint` is considered stable and is used in various projects as a development tool.
 
 > **Ideas**: [conventional-changelog/commitlint#94](https://github.com/conventional-changelog/commitlint/issues/94)
 
@@ -205,16 +205,16 @@ Check the [main website](https://commitlint.js.org/).
 Security patches will be applied to versions which are not yet EOL.\
 Features will only be applied to the current main version.
 
-| Release                                                                          | Inital release |
-| -------------------------------------------------------------------------------- | -------------- |
-| [v18](https://github.com/conventional-changelog/commitlint/releases/tag/v18.0.0) | 10/2023        |
-| [v17](https://github.com/conventional-changelog/commitlint/releases/tag/v17.0.0) | 05/2022        |
-| [v16](https://github.com/conventional-changelog/commitlint/releases/tag/v16.0.0) | 12/2021        |
-| [v15](https://github.com/conventional-changelog/commitlint/releases/tag/v15.0.0) | 11/2021        |
-| [v14](https://github.com/conventional-changelog/commitlint/releases/tag/v14.0.0) | 10/2021        |
-| [v13](https://github.com/conventional-changelog/commitlint/releases/tag/v13.0.0) | 05/2021        |
-| [v12](https://github.com/conventional-changelog/commitlint/releases/tag/v12.0.0) | 02/2021        |
-| [v11](https://github.com/conventional-changelog/commitlint/releases/tag/v11.0.0) | 09/2020        |
+| Release                                                                          | Initial release |
+| -------------------------------------------------------------------------------- | --------------- |
+| [v18](https://github.com/conventional-changelog/commitlint/releases/tag/v18.0.0) | 10/2023         |
+| [v17](https://github.com/conventional-changelog/commitlint/releases/tag/v17.0.0) | 05/2022         |
+| [v16](https://github.com/conventional-changelog/commitlint/releases/tag/v16.0.0) | 12/2021         |
+| [v15](https://github.com/conventional-changelog/commitlint/releases/tag/v15.0.0) | 11/2021         |
+| [v14](https://github.com/conventional-changelog/commitlint/releases/tag/v14.0.0) | 10/2021         |
+| [v13](https://github.com/conventional-changelog/commitlint/releases/tag/v13.0.0) | 05/2021         |
+| [v12](https://github.com/conventional-changelog/commitlint/releases/tag/v12.0.0) | 02/2021         |
+| [v11](https://github.com/conventional-changelog/commitlint/releases/tag/v11.0.0) | 09/2020         |
 
 EOL is usually after around a year.
 
@@ -285,11 +285,11 @@ yarn test
 yarn run publish --otp <one-time password>
 ```
 
-If something in between fails (like a new packages was added and needs to be published for the
-first time but you forgot) you can use `lerna publish from-package` to publish anythign that
+If something in between fails (like a new package was added and needs to be published for the
+first time but you forgot) you can use `lerna publish from-package` to publish anything that
 has not been published yet.
 
-#### Create Github release
+#### Create GitHub release
 
 1. Copy changelog entry for the new version
 1. Create release for the new tag: https://github.com/conventional-changelog/commitlint/releases
diff --git a/docs/guides-ci-setup.md b/docs/guides-ci-setup.md
@@ -102,7 +102,7 @@ jobs:
     - attach_workspace:
         at: ~/project
     - run:
-        name: Define environment variable with lastest commit's message
+        name: Define environment variable with latest commit's message
         command: |
           echo 'export COMMIT_MESSAGE=$(git log -1 --pretty=format:"%s")' >> $BASH_ENV
           source $BASH_ENV
diff --git a/docs/guides-releases.md b/docs/guides-releases.md
@@ -3,13 +3,13 @@
 Security patches will be applied to versions which are not yet EOL.  
 Features will only be applied to the current main version.
 
-| Release                                                                          | Inital release | End-of-life |
-| -------------------------------------------------------------------------------- | -------------- | ----------- |
-| [v13](https://github.com/conventional-changelog/commitlint/releases/tag/v13.0.0) | 24.05.2021     | 24.05.2022  |
-| [v12](https://github.com/conventional-changelog/commitlint/releases/tag/v12.0.0) | 23.02.2021     | 23.02.2022  |
-| [v11](https://github.com/conventional-changelog/commitlint/releases/tag/v11.0.0) | 13.09.2020     | 13.09.2020  |
+| Release                                                                          | Initial release | End-of-life |
+| -------------------------------------------------------------------------------- | --------------- | ----------- |
+| [v13](https://github.com/conventional-changelog/commitlint/releases/tag/v13.0.0) | 24.05.2021      | 24.05.2022  |
+| [v12](https://github.com/conventional-changelog/commitlint/releases/tag/v12.0.0) | 23.02.2021      | 23.02.2022  |
+| [v11](https://github.com/conventional-changelog/commitlint/releases/tag/v11.0.0) | 13.09.2020      | 13.09.2020  |
 
 _Dates are subject to change._
 
-We're not a sponsored OSS project. Therefor we can't promise that we will release patch versions for older releases in a timley manner.  
+We're not a sponsored OSS project. Therefore we can't promise that we will release patch versions for older releases in a timely manner.  
 If you are stuck on an older version and need a security patch we're happy if you can provide a PR.
diff --git a/docs/reference-api.md b/docs/reference-api.md
@@ -446,7 +446,7 @@ read({to: 'HEAD', from: 'HEAD~2'}).then((commits) =>
 );
 ```
 
-- **Simplfied last-commit checker**
+- **Simplified last-commit checker**
 
 ```js
 const load = require('@commitlint/load').default;
diff --git a/docs/reference-community-projects.md b/docs/reference-community-projects.md
@@ -11,7 +11,7 @@ If you want to add a project to this list [open a pull request](https://github.c
 ## List of Projects
 
 - [Gitmoji Commit Workflow](https://github.com/arvinxx/gitmoji-commit-workflow)
-- [commitlint.io](https://github.com/tomasen/commitlintio) - helps your project to ensures nice and tidy commit messages without needing any download or installation
+- [commitlint.io](https://github.com/tomasen/commitlintio) - helps your project to ensure nice and tidy commit messages without needing any download or installation
 - [commitlint plugin function rules](https://github.com/vidavidorra/commitlint-plugin-function-rules) - use functions as rule value to create rules based on commit messages, with regular expressions and more
 - [commitlint-plugin-selective-scope](https://github.com/ridvanaltun/commitlint-plugin-selective-scope) - limit scopes per type with regular expressions and plain text
 - [commitlint-gitlab-ci](https://gitlab.com/dmoonfire/commitlint-gitlab-ci/) - a small wrapper around `commitlint` for working with the quirks of Gitlab's CI without failing jobs
diff --git a/docs/reference-prompt.md b/docs/reference-prompt.md
@@ -9,22 +9,22 @@ There are three fields: `settings`, `messages` and `questions`
 Set optional options.
 
 - `enableMultipleScopes`: `(boolean)` Enable multiple scopes, select scope with a radio list, disabled by default.
-- `scopeEnumSeparator`: `(string)` Commitlint supports [multiple scopes](./concepts-commit-conventions.md?id=multiple-scopes), you can specify the delimiter.It is applied when `enableMultipleScopes` set true.
+- `scopeEnumSeparator`: `(string)` Commitlint supports [multiple scopes](./concepts-commit-conventions.md?id=multiple-scopes), you can specify the delimiter. It is applied when `enableMultipleScopes` set true.
 
 ## `messages`
 
 Set hint contents, you can configure it to support localization.
 
-- `skip`: The field can be skip by enter
+- `skip`: The field can be skipped by pressing enter
 - `max`: Maximum number of characters
 - `min`: Minimum number of characters
-- `emptyWarning`: The field can not be empty
-- `upperLimitWarning`: The characters limit is exceeded
-- `lowerLimitWarning`: The characters is less than lower limit
+- `emptyWarning`: The field cannot be empty
+- `upperLimitWarning`: The character limit is exceeded
+- `lowerLimitWarning`: The characters are less than lower limit
 
 ## `questions`
 
-Specify the interactive steps, Steps can only be configure in
+Specify the interactive steps, Steps can only be configured in
 
 - `header`
 - `type`
