Skip to content

Commit 5997ad7

Browse files
schlotterLee-W
authored andcommitted
docs(commit.md): add documentation for always_signoff config setting
1 parent 2063328 commit 5997ad7

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

docs/commit.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,20 @@ write the message to a file and not modify files and create a commit. A possible
1212
case for this is to [automatically prepare a commit message](./tutorials/auto_prepare_commit_message.md).
1313

1414
!!! note
15-
To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
16-
In particular pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).
15+
To maintain platform compatibility, the `commit` command disables ANSI escaping in its output.
16+
In particular, pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).
17+
18+
## Configuration
19+
20+
### `always_signoff`
21+
22+
When set to `true`, each commit message created by `cz commit` will be signed off.
23+
24+
Defaults to: `false`.
25+
26+
In your `pyproject.toml` or `.cz.toml`:
27+
28+
```toml
29+
[tool.commitizen]
30+
always_signoff = true
31+
```

0 commit comments

Comments
 (0)