Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit fe69da8

Browse files
woilewoile
committed
docs: correct typos and outdated info
Closes #288
1 parent 019fc94 commit fe69da8

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

‎docs/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ If you're a first-time contributor, you can check the issues with [good first is
1717
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
1818
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit.
1919
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
20-
9. Update `READMD.md` and `CHANGELOG.md` for your changes.
20+
9. Update `README.md` and `CHANGELOG.md` for your changes.
2121
10. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏

‎docs/customization.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ message = "Do you want to add body message in commit?"
4848

4949
### Customize configuration
5050

51-
| Parameter | Type | Default | Description |
52-
| ------------------ | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
53-
| `questions` | `dict` | `None` | Questions regarding the commit message. Detailed below. |
54-
| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should either follow the [string.Template](https://docs.python.org/3/library/string.html#template-strings) or [Jinja2](https://jinja.palletsprojects.com/en/2.10.x/) formatting specification, and all the variables in this template should be defined in `name` in `questions`. Note that `Jinja2` is not installed by default. If not installed, commitizen will use `string.Template` formatting. |
55-
| `example` | `str` | `None` | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. |
56-
| `schema` | `str` | `None` | (OPTIONAL) Show the schema used. Used by `cz schema`. |
57-
| `schema_pattern` | `str` | `None` | (OPTIONAL) The regular expression used to do commit message validation. Used by `cz check`. |
58-
| `info_path` | `str` | `None` | (OPTIONAL) The path to the file that contains explanation of the commit rules. Used by `cz info`. If not provided `cz info`, will load `info` instead. |
59-
| `info` | `str` | `None` | (OPTIONAL) Explanation of the commit rules. Used by `cz info`. |
60-
| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) |
61-
| `bump_pattern` | `str` | `None` | (OPTIONAL) Regex to extract information from commit (subject and body) |
51+
| Parameter | Type | Default | Description |
52+
| ------------------ | ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
53+
| `questions` | `dict` | `None` | Questions regarding the commit message. Detailed below. |
54+
| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should either follow [Jinja2](https://jinja.palletsprojects.com/en/2.10.x/) formatting specification, and all the variables in this template should be defined in `name` in `questions` |
55+
| `example` | `str` | `None` | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. |
56+
| `schema` | `str` | `None` | (OPTIONAL) Show the schema used. Used by `cz schema`. |
57+
| `schema_pattern` | `str` | `None` | (OPTIONAL) The regular expression used to do commit message validation. Used by `cz check`. |
58+
| `info_path` | `str` | `None` | (OPTIONAL) The path to the file that contains explanation of the commit rules. Used by `cz info`. If not provided `cz info`, will load `info` instead. |
59+
| `info` | `str` | `None` | (OPTIONAL) Explanation of the commit rules. Used by `cz info`. |
60+
| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) |
61+
| `bump_pattern` | `str` | `None` | (OPTIONAL) Regex to extract information from commit (subject and body) |
6262

6363
#### Detailed `questions` content
6464

0 commit comments

Comments
 (0)