Skip to content

Commit

Permalink
docs(commit.md): add documentation for always_signoff config setting
Browse files Browse the repository at this point in the history
  • Loading branch information
schlotter authored and Lee-W committed Sep 5, 2023
1 parent 2063328 commit 5997ad7
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,20 @@ write the message to a file and not modify files and create a commit. A possible
case for this is to [automatically prepare a commit message](./tutorials/auto_prepare_commit_message.md).

!!! note
To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
In particular pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).
To maintain platform compatibility, the `commit` command disables ANSI escaping in its output.
In particular, pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).

## Configuration

### `always_signoff`

When set to `true`, each commit message created by `cz commit` will be signed off.

Defaults to: `false`.

In your `pyproject.toml` or `.cz.toml`:

```toml
[tool.commitizen]
always_signoff = true
```

0 comments on commit 5997ad7

Please sign in to comment.