php-commitizen - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #android #deep-learning #linux #java #awesome #awesome-list #vue #pytorch #mcp #openai

php-commitizen

(★ 119)

PHP Commitizen - A CLI tool used to create commits according to Conventional Commits specification

File Explorer

Download Latest Version (.zip)

- - InvalidArgumentException.php
- - Body.php
  - Description.php
  - Footer.php
  - Scope.php
  - Subject.php
  - Type.php
- CommitCommand.php
- Configuration.php
- CreateConventionalCommit.php
- - CommitCommandTest.php
  - ConfigurationTest.php
  - CreateConventionalCommitTest.php
.gitignore
.php-commitizen.php
.scrutinizer.yml
composer.json
composer.lock
LICENSE
php-commitizen
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/conventional-commits/php-commitizen

Downloads the entire project code from GitHub to your computer.

cd php-commitizen

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer install

Installs the PHP libraries listed in composer.json.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PHP Commitizen

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/?branch=master)
[![Build Status](https://scrutinizer-ci.com/g/damianopetrungaro/php-commitizen/badges/build.png?b=master)](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

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

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

```
<?php

return [
    'type' => [
        'lengthMin' => 1, // Min length of the type
        'lengthMax' => 5, // Max length of the type
        'acceptExtra' => false, // Allow adding types not listed in 'values' key
        'values' => ['feat', 'fix'], // All the values usable as type
    ],
    'scope' => [
        'lengthMin' => 0, // Min length of the scope
        'lengthMax' => 10, // Max length of the scope
        'acceptExtra' => true, // Allow adding scopes not listed in 'values' key
        'values' => [], // All the values usable as scope
    ],
    'description' => [
        'lengthMin' => 1, // Min length of the description
        'lengthMax' => 44, // Max length of the description
    ],
    'subject' => [
        'lengthMin' => 1, // Min length of the subject
        'lengthMax' => 50, // Max length of the subject
    ],
    'body' => [
        'wrap' => 72, // Wrap the body at 72 characters
    ],
    'footer' => [
        'wrap' => 72, Wrap the footer at 72 characters
    ],
];
```