diff --git a/.gitignore b/.gitignore index 5b4e933e35..987c1a9c60 100644 --- a/.gitignore +++ b/.gitignore @@ -110,3 +110,6 @@ venv.bak/ # build poetry.lock + +# macOSX +.DS_Store diff --git a/docs/commit.md b/docs/commit.md new file mode 100644 index 0000000000..fb3fdd65ac --- /dev/null +++ b/docs/commit.md @@ -0,0 +1,11 @@ +![Using commitizen cli](images/demo.gif) + +## About + +In your terminal run `cz commit` or the shortcut `cz c` to generate a guided git commit. + +A commit can be signed off using `cz commit --signoff` or the shortcut `cz commit -s`. + +!!! 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). diff --git a/mkdocs.yml b/mkdocs.yml index 038581b0b2..7d8dc430b0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,6 +12,7 @@ nav: - Introduction: 'README.md' - Commands: - Init: 'init.md' + - Commit: 'commit.md' - Bump: 'bump.md' - Check: 'check.md' - Changelog: 'changelog.md'