Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 377c8b0

Browse files
docs: fix typo issues in cli.py, README.md, and contributing.md
1 parent 536d0ad commit 377c8b0

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

‎commitizen/cli.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def __call__(
105105
"name": ["-nr", "--no-raise"],
106106
"type": str,
107107
"required": False,
108-
"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/",
108+
"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/",
109109
},
110110
],
111111
"subcommands": {

‎docs/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@
1818

1919
## About
2020

21-
Commitizen is release management tool designed for teams.
21+
Commitizen is a release management tool designed for teams.
2222

2323
Commitizen assumes your team uses a standard way of committing rules
2424
and from that foundation, it can bump your project's version, create
2525
the changelog, and update files.
2626

2727
By default, commitizen uses [conventional commits][conventional_commits], but you
28-
can build your own set of rules, and publish them.
28+
can build your own set of rules and publish them.
2929

30-
Using a standardized set of rules to write commits, makes commits easier to read, and enforces writing
30+
Using a standardized set of rules to write commits makes commits easier to read and enforces writing
3131
descriptive commits.
3232

3333
### Features
@@ -55,15 +55,15 @@ pipx install commitizen
5555
pipx upgrade commitizen
5656
```
5757

58-
Install commitizen using `pip` with `--user` flag:
58+
Install commitizen using `pip` with the `--user` flag:
5959

6060
```bash
6161
pip install --user -U commitizen
6262
```
6363

6464
### Python project
6565

66-
You can add it to your local project using one of the following.
66+
You can add it to your local project using one of the following methods.
6767

6868
With `pip`:
6969

@@ -99,7 +99,7 @@ brew install commitizen
9999

100100
## Usage
101101

102-
Most of the time this is the only command you'll run:
102+
Most of the time, this is the only command you'll run:
103103

104104
```sh
105105
cz bump
@@ -120,15 +120,15 @@ $ cz --help
120120
usage: cz [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
121121

122122
Commitizen is a cli tool to generate conventional commits.
123-
For more information about the topic go to https://conventionalcommits.org/
123+
For more information about the topic, go to https://conventionalcommits.org/
124124

125125
optional arguments:
126126
-h, --help show this help message and exit
127127
--config the path of configuration file
128128
--debug use debug mode
129129
-n NAME, --name NAME use the given commitizen (default: cz_conventional_commits)
130130
-nr NO_RAISE, --no-raise NO_RAISE
131-
comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-
131+
comma separated error codes that won't raise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-
132132
tools.github.io/commitizen/exit_codes/
133133
134134
commands:
@@ -147,7 +147,7 @@ commands:
147147
148148
## Setting up bash completion
149149
150-
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.
150+
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.
151151
152152
argcomplete is installed when you install Commitizen since it's a dependency.
153153

‎docs/contributing.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ First of all, thank you for taking the time to contribute! 🎉
44

55
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.
66

7-
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.
7+
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.
88

99
## Install before contributing
1010

11-
1. Install [poetry](https://python-poetry.org/) `>=2.0.0`. See installation [pages](https://python-poetry.org/docs/#installing-with-the-official-installer).
12-
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/).
11+
1. Install [poetry](https://python-poetry.org/) `>=2.0.0`. See the installation [pages](https://python-poetry.org/docs/#installing-with-the-official-installer).
12+
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/).
1313

1414
## Before making a pull request
1515

1616
1. Fork [the repository](https://github.com/commitizen-tools/commitizen).
17-
1. Clone the repository from your GitHub.
18-
1. Set up development environment through [poetry](https://python-poetry.org/) (`poetry install`).
19-
1. Set up [pre-commit](https://pre-commit.com/) hook (`poetry setup-pre-commit`).
20-
1. Checkout a new branch and add your modifications.
21-
1. Add test cases for all your changes.
17+
2. Clone the repository from your GitHub.
18+
3. Set up the development environment through [poetry](https://python-poetry.org/) (`poetry install`).
19+
4. Set up the [pre-commit](https://pre-commit.com/) hook (`poetry setup-pre-commit`).
20+
5. Checkout a new branch and add your modifications.
21+
6. Add test cases for all your changes.
2222
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
23-
1. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commits](https://www.conventionalcommits.org/).
24-
1. Run `poetry all` to ensure you follow the coding style and the tests pass.
25-
1. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (through running `poetry doc:screenshots`).
26-
1. **Do not** update the `CHANGELOG.md`; it will be automatically created after merging to `master`.
27-
1. **Do not** update the versions in the project; they will be automatically updated.
28-
1. If your changes are about documentation, run `poetry doc` to serve documentation locally and check whether there are any warnings or errors.
29-
1. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
23+
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to make git commits. We follow [conventional commits](https://www.conventionalcommits.org/).
24+
8. Run `poetry all` to ensure you follow the coding style and the tests pass.
25+
9. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (by running `poetry doc:screenshots`).
26+
10. **Do not** update the `CHANGELOG.md`; it will be automatically created after merging to `master`.
27+
11. **Do not** update the versions in the project; they will be automatically updated.
28+
12. If your changes are about documentation, run `poetry doc` to serve documentation locally and check whether there are any warnings or errors.
29+
13. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
3030

3131
## Use of GitHub Labels
3232

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /