From 17dd7ad85c8cd0389d9e00007a7bf6d4d72b4817 Mon Sep 17 00:00:00 2001 From: Wei Lee Date: Wed, 3 Jun 2020 22:56:25 +0800 Subject: [PATCH 1/2] docs: fix typo --- docs/bump.md | 2 +- docs/changelog.md | 4 ++-- docs/customization.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/bump.md b/docs/bump.md index efcef4a3b3..d09e3e1931 100644 --- a/docs/bump.md +++ b/docs/bump.md @@ -71,7 +71,7 @@ optional arguments: the format used to tag the commit and read it, use it in existing projects, wrap around simple quotes --bump-message BUMP_MESSAGE - template used to create the release commmit, useful + template used to create the release commit, useful when working with CI --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc} choose type of prerelease diff --git a/docs/changelog.md b/docs/changelog.md index 2c78761324..a50b906df1 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,6 +1,6 @@ ## About -This command will generate a changelog following the commiting rules established. +This command will generate a changelog following the committing rules established. ## Usage @@ -66,7 +66,7 @@ and the following variables are expected: | `change_type` | The group where the commit belongs to, this is optional. Example: fix | `commit regex` | | `message`\* | Information extracted from the commit message | `commit regex` | | `scope` | Contextual information. Should be parsed using the regex from the message, it will be **bold** | `commit regex` | -| `breaking` | Wether is a breaking change or not | `commit regex` | +| `breaking` | Whether is a breaking change or not | `commit regex` | - **required**: is the only one required to be parsed by the regex diff --git a/docs/customization.md b/docs/customization.md index 721ade60b3..b74d086957 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -177,7 +177,7 @@ class StrangeCommitizen(BaseCommitizen): the new updated full_changelog """ if partial_changelog: - chat.room("#commiters").notify(partial_changelog) + chat.room("#committers").notify(partial_changelog) if full_changelog: compliance.send(full_changelog) full_changelog.replace(' fix ', ' **fix** ') @@ -214,7 +214,7 @@ name = "cz_customize" [tool.commitizen.customize] message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" -example = "feature: this feature eanable customize through config file" +example = "feature: this feature enable customize through config file" schema = ":
" bump_pattern = "^(break|new|fix|hotfix)" bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"} From d85b649deacec2bb3f47709289b0a3067dedcc29 Mon Sep 17 00:00:00 2001 From: Wei Lee Date: Wed, 3 Jun 2020 23:40:20 +0800 Subject: [PATCH 2/2] docs: add github page link to README --- docs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/README.md b/docs/README.md index 8aee8e4ea0..a7d4333b1d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,8 @@ versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-squar ![Using commitizen cli](images/demo.gif) +View full [documentation](https://commitizen-tools.github.io/commitizen/). + ## About Commitizen is a tool designed for teams.

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