Add GitHub page link to readme #198

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.
Expand Down

2 changes: 1 addition & 1 deletion docs/bump.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
Expand Down

4 changes: 2 additions & 2 deletions docs/changelog.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -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

Expand Down Expand Up		@@ -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

Expand Down

4 changes: 2 additions & 2 deletions docs/customization.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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 ')
Expand Down Expand Up		@@ -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 = "<type>: <body>"
		bump_pattern = "^(break\|new\|fix\|hotfix)"
		bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"}
Expand Down

Navigation Menu