commitizen 4.13.7

The commitizen Python package is a release management tool designed to streamline and standardize the process of committing changes in a team setting. It assumes that your team uses a standard way of committing rules and based on that, it can automatically bump your project's version, create a changelog, and update files. By default, commitizen uses conventional commits, but it allows for customization of rules. The package provides a command-line utility to create commits with your rules, and it can display information about your commit rules.

Stars: 3291, Watchers: 3291, Forks: 322, Open Issues: 144

The commitizen-tools/commitizen repo was created 8 years ago and the last code push was Yesterday.
The project is very popular with an impressive 3291 github stars!

How to Install commitizen

You can install commitizen using pip

pip install commitizen

or add it to a project with poetry

poetry add commitizen

Package Details

Author

Santiago Fraire

License

MIT License

     Copyright (c) 2017 Santiago
     
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal
     in the Software without restriction, including without limitation the rights
     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     copies of the Software, and to permit persons to whom the Software is
     furnished to do so, subject to the following conditions:
     
     The above copyright notice and this permission notice shall be included in all
     copies or substantial portions of the Software.
     
     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     SOFTWARE.</dd>

Homepage

None

PyPi:

https://pypi.org/project/commitizen/

Documentation:

https://commitizen-tools.github.io/commitizen/

GitHub Repo:

https://github.com/commitizen-tools/commitizen

Classifiers

Related Packages

Errors

A list of common commitizen errors.

Code Examples

Here are some commitizen code examples and snippets.

GitHub Issues

The commitizen package has 144 open issues on GitHub

• Commitizen now attempts to enforce its rules the entire history of the project
• Broken Links Report
• feat: add postrelease version
• docs: add revision date plugin
• fix(message_length_limit): align the behavior of message_length_limit
• fix: try to use ChainMap to chain settings, fix message_length_limit inconsistency
• Add pytest ruff rules
• fix(changelog): add incremental parameter to changelog generation
• fix(config): include pyproject.toml in multi config file warning
• feat(bump): add –version-files-only and deprecate –files-only
• feat(cli): add cz –version back and add cz –report to separate them from cz version
• build: remove unnecessary poe config in pyproject.toml
• docs(changelog): fix minor mistakes in changelog documentation, improve fluency
• 4.11.0 is missing on PyPI
• BREAKING: Add --version back and deprecate cz version --commitizen which is the default for cz version

See more issues on GitHub