PHPackages                             damianopetrungaro/php-commitizen - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. damianopetrungaro/php-commitizen

ActiveLibrary

damianopetrungaro/php-commitizen
================================

Help writing Git commit following conventional commit specs

v0.2.0(5y ago)11981.7k—0%13[4 issues](https://github.com/damianopetrungaro/php-commitizen/issues)15MITPHPCI failing

Since Feb 21Pushed 3y ago3 watchersCompare

[ Source](https://github.com/damianopetrungaro/php-commitizen)[ Packagist](https://packagist.org/packages/damianopetrungaro/php-commitizen)[ RSS](/packages/damianopetrungaro-php-commitizen/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (3)Versions (5)Used By (15)

PHP Commitizen
==============

[](#php-commitizen)

[![Scrutinizer Code Quality](https://camo.githubusercontent.com/83002d33c4a72189d51caab5fde54405fc689293ef37a7f584453b305722e187/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f64616d69616e6f70657472756e6761726f2f7068702d636f6d6d6974697a656e2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/ec54d88672b0da39799abe16ed9bc5817398aab3aa662e8a2e655310124f0e11/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f64616d69616e6f70657472756e6761726f2f7068702d636f6d6d6974697a656e2f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/?branch=master)[![Build Status](https://camo.githubusercontent.com/f89b5d949860f8c9a74466d08c6c06f73503c3a5b1bd650333c43aed6ebfaa55/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f64616d69616e6f70657472756e6761726f2f7068702d636f6d6d6974697a656e2f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/build-status/master)

Commitizen is a tool built for create good commits for a clean and readable git history.

This tool follow the [Conventional Commit specs](https://conventionalcommits.org/) and some best practices described in [this slides](https://slides.com/damianopetrungaro/working-with-git)

Installation and usage
======================

[](#installation-and-usage)

You can install it easily with composer

`$ php composer.phar require --dev damianopetrungaro/php-commitizen`

Usage is simple too

`$ php vendor/bin/php-commitizen commit`

You can also

- pass a flag for add all the file to the stage: `-a`
- specify a custom configuration file adding the file path as argument

You can ask for more information using: `$ php vendor/bin/php-commitizen commit --help`

Configuration file
==================

[](#configuration-file)

The configuration file must return an array (or partial override)

```