Commit e08d0d5

committed

docs: add encoding configuration

1 parent c1b2733 commit e08d0d5Copy full SHA for e08d0d5

File tree

+13

-0

lines changed

+13

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -184,6 +184,14 @@ Default: `[]`
`184`	`184`
`185`	`185`	`Calls the hook scripts after bumping the version. [Read more][post_bump_hooks]`
`186`	`186`
	`187`	+### `encoding`
	`188`	`+`
	`189`	+Type: `str`
	`190`	`+`
	`191`	+Default: `utf-8`
	`192`	`+`
	`193`	`+Sets the character encoding to be used when parsing commit messages. [Read more][encoding]`
	`194`	`+`
`187`	`195`	`## Configuration file`
`188`	`196`
`189`	`197`	`### pyproject.toml or .cz.toml`
`@@ -357,3 +365,4 @@ setup(`
`357`	`365`	`[customization]: customization.md`
`358`	`366`	`[shortcuts]: customization.md#shortcut-keys`
`359`	`367`	`[annotated-tags-vs-lightweight]: https://stackoverflow.com/a/11514139/2047185`
	`368`	`+[encoding]: tutorials/writing_commits.md#writing-commits`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ Now to the important part, when writing commits, it's important to think about:`
`23`	`23`	`You may think this is trivial, but it's not. It's important for the reader to`
`24`	`24`	`understand what happened.`
`25`	`25`
	`26`	+Emojis may be added as well (e.g. see [cz-emoji][cz_emoji]), which requires the `utf-8`, or equivalent, character encoding to support unicode characters. By default, `commitizen` uses the `utf-8` character encoding, but a different encoding may be set through the `encoding` [configuration option][configuration].
	`27`	`+`
`26`	`28`	`### Recommendations`
`27`	`29`
`28`	`30`	`- Keep the message short: Makes the list of commits more readable (~50 chars).`
`@@ -40,3 +42,5 @@ understand what happened.`
`40`	`42`
`41`	`43`	`[customization]: ../customization.md`
`42`	`44`	`[conventional_commits]: https://www.conventionalcommits.org`
	`45`	`+[cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-commitizen/#cz-emoji`
	`46`	`+[configuration]: ../config.md#encoding`

Comments

(0)