Commit f502e08

author

David Arnold

authored

docs(customization): Update customization.md

fixes #202

1 parent a108872 commit f502e08Copy full SHA for f502e08

File tree

1 file changed

-4

lines changed

docs
- customization.md

1 file changed

-4

lines changed

`‎docs/customization.md‎`

Lines changed: 5 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,8 @@ This is customized info`
`226`	`226`	`[[tool.commitizen.customize.questions]]`
`227`	`227`	`type = "list"`
`228`	`228`	`name = "change_type"`
`229`		`-choices = ["feature", "bug fix"]`
	`229`	`+choices = [{value = "feature", name = "feature: A new feature."}, {value = "bug fix", name = "bug fix: A bug fix."}]`
	`230`	`+# choices = ["feature", "fix"] # short version`
`230`	`231`	`message = "Select the type of change you are committing"`
`231`	`232`
`232`	`233`	`[[tool.commitizen.customize.questions]]`
`@@ -244,7 +245,7 @@ message = "Do you want to add body message in commit?"`
`244`	`245`
`245`	`246`	`\| Parameter \| Type \| Default \| Description \|`
`246`	`247`	\| ------------------ \| ------ \| ------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \|
`247`		-\| `question` \| `dict` \| `None` \| Questions regarding the commit message. Detailed below. \|
	`248`	+\| `questions` \| `dict` \| `None` \| Questions regarding the commit message. Detailed below. \|
`248`	`249`	\| `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. \|
`249`	`250`	\| `example` \| `str` \| `None` \| (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. \|
`250`	`251`	\| `schema` \| `str` \| `None` \| (OPTIONAL) Show the schema used. Used by `cz schema`. \|
`@@ -253,13 +254,13 @@ message = "Do you want to add body message in commit?"`
`253`	`254`	\| `bump_map` \| `dict` \| `None` \| (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) \|
`254`	`255`	\| `bump_pattern` \| `str` \| `None` \| (OPTIONAL) Regex to extract information from commit (subject and body) \|
`255`	`256`
`256`		-#### Detailed `question` content
	`257`	+#### Detailed `questions` content
`257`	`258`
`258`	`259`	`\| Parameter \| Type \| Default \| Description \|`
`259`	`260`	`\| --------- \| ------ \| ------- \| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \|`
`260`	`261`	\| `type` \| `str` \| `None` \| The type of questions. Valid type: `list`, `input` and etc. [See More](https://github.com/tmbo/questionary#different-question-types) \|
`261`	`262`	\| `name` \| `str` \| `None` \| The key for the value answered by user. It's used in `message_template` \|
`262`	`263`	\| `message` \| `str` \| `None` \| Detail description for the question. \|
`263`		-\| `choices` \| `list` \| `None` \| (OPTIONAL) The choices when `type = choice`. It should be list of dictionaries with `name` and `value`. (e.g., `[{value = "feature", name = "feature: A new feature."}, {value = "bug fix", name = "bug fix: A bug fix."}]`) \|
	`264`	+\| `choices` \| `list` \| `None` \| (OPTIONAL) The choices when `type = list`. Either use a list of values or a list of dicitionaries with `name` and `value` keys. See examples above. \|
`264`	`265`	\| `default` \| `Any` \| `None` \| (OPTIONAL) The default value for this question. \|
`265`	`266`	\| `filter` \| `str` \| `None` \| (Optional) Validator for user's answer. (Work in Progress) \|

0 commit comments

Comments

(0)

Navigation Menu

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit f502e08

File tree

1 file changed

1 file changed

`‎docs/customization.md‎`

0 commit comments