docs: fix typo issues in cli.py, README.md, and contributing.md

Author: bearomorphism

commitizen/cli.py

@@ -105,7 +105,7 @@ def __call__(
             "name": ["-nr", "--no-raise"],
             "type": str,
             "required": False,
-            "help": "comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
+            "help": "comma separated error codes that won't raise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
         },
     ],
     "subcommands": {

docs/README.md

@@ -18,16 +18,16 @@
 
 ## About
 
-Commitizen is release management tool designed for teams.
+Commitizen is a release management tool designed for teams.
 
 Commitizen assumes your team uses a standard way of committing rules
 and from that foundation, it can bump your project's version, create
 the changelog, and update files.
 
 By default, commitizen uses [conventional commits][conventional_commits], but you
-can build your own set of rules, and publish them.
+can build your own set of rules and publish them.
 
-Using a standardized set of rules to write commits, makes commits easier to read, and enforces writing
+Using a standardized set of rules to write commits makes commits easier to read and enforces writing
 descriptive commits.
 
 ### Features
@@ -55,15 +55,15 @@ pipx install commitizen
 pipx upgrade commitizen
 ```
 
-Install commitizen using `pip` with `--user` flag:
+Install commitizen using `pip` with the `--user` flag:
 
 ```bash
 pip install --user -U commitizen
 ```
 
 ### Python project
 
-You can add it to your local project using one of the following.
+You can add it to your local project using one of the following methods.
 
 With `pip`:
 
@@ -99,7 +99,7 @@ brew install commitizen
 
 ## Usage
 
-Most of the time this is the only command you'll run:
+Most of the time, this is the only command you'll run:
 
 ```sh
 cz bump
@@ -120,15 +120,15 @@ $ cz --help
 usage: cz [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
 
 Commitizen is a cli tool to generate conventional commits.
-For more information about the topic go to https://conventionalcommits.org/
+For more information about the topic, go to https://conventionalcommits.org/
 
 optional arguments:
   -h, --help            show this help message and exit
   --config              the path of configuration file
   --debug               use debug mode
   -n NAME, --name NAME  use the given commitizen (default: cz_conventional_commits)
   -nr NO_RAISE, --no-raise NO_RAISE
-                        comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-
+                        comma separated error codes that won't raise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-
                         tools.github.io/commitizen/exit_codes/
 
 commands:
@@ -147,7 +147,7 @@ commands:
 
 ## Setting up bash completion
 
-When using bash as your shell (limited support for zsh, fish, and tcsh is available), Commitizen can use [argcomplete](https://kislyuk.github.io/argcomplete/) for auto-completion. For this argcomplete needs to be enabled.
+When using bash as your shell (limited support for zsh, fish, and tcsh is available), Commitizen can use [argcomplete](https://kislyuk.github.io/argcomplete/) for auto-completion. For this, argcomplete needs to be enabled.
 
 argcomplete is installed when you install Commitizen since it's a dependency.
 

docs/contributing.md

@@ -4,29 +4,29 @@ First of all, thank you for taking the time to contribute! 🎉
 
 When contributing to [commitizen](https://github.com/commitizen-tools/commitizen), please first create an [issue](https://github.com/commitizen-tools/commitizen/issues) to discuss the change you wish to make before making a change.
 
-If you're a first-time contributor, you can check the issues with [good first issue](https://github.com/commitizen-tools/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag.
+If you're a first-time contributor, you can check the issues with the [good first issue](https://github.com/commitizen-tools/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag.
 
 ## Install before contributing
 
-1. Install [poetry](https://python-poetry.org/) `>=2.0.0`. See installation [pages](https://python-poetry.org/docs/#installing-with-the-official-installer).
-2. Install [gpg](https://gnupg.org). See installation [pages](https://gnupg.org/documentation/manuals/gnupg/Installation.html#Installation). For Mac users, you can use [homebrew](https://brew.sh/).
+1. Install [poetry](https://python-poetry.org/) `>=2.0.0`. See the installation [pages](https://python-poetry.org/docs/#installing-with-the-official-installer).
+2. Install [gpg](https://gnupg.org). See the installation [pages](https://gnupg.org/documentation/manuals/gnupg/Installation.html#Installation). For Mac users, you can use [homebrew](https://brew.sh/).
 
 ## Before making a pull request
 
 1. Fork [the repository](https://github.com/commitizen-tools/commitizen).
-1. Clone the repository from your GitHub.
-1. Set up development environment through [poetry](https://python-poetry.org/) (`poetry install`).
-1. Set up [pre-commit](https://pre-commit.com/) hook (`poetry setup-pre-commit`).
-1. Checkout a new branch and add your modifications.
-1. Add test cases for all your changes.
+2. Clone the repository from your GitHub.
+3. Set up the development environment through [poetry](https://python-poetry.org/) (`poetry install`).
+4. Set up the [pre-commit](https://pre-commit.com/) hook (`poetry setup-pre-commit`).
+5. Checkout a new branch and add your modifications.
+6. Add test cases for all your changes.
    (We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
-1. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commits](https://www.conventionalcommits.org/).
-1. Run `poetry all` to ensure you follow the coding style and the tests pass.
-1. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (through running `poetry doc:screenshots`).
-1. **Do not** update the `CHANGELOG.md`; it will be automatically created after merging to `master`.
-1. **Do not** update the versions in the project; they will be automatically updated.
-1. If your changes are about documentation, run `poetry doc` to serve documentation locally and check whether there are any warnings or errors.
-1. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
+7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to make git commits. We follow [conventional commits](https://www.conventionalcommits.org/).
+8. Run `poetry all` to ensure you follow the coding style and the tests pass.
+9. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (by running `poetry doc:screenshots`).
+10. **Do not** update the `CHANGELOG.md`; it will be automatically created after merging to `master`.
+11. **Do not** update the versions in the project; they will be automatically updated.
+12. If your changes are about documentation, run `poetry doc` to serve documentation locally and check whether there are any warnings or errors.
+13. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
 
 ## Use of GitHub Labels