{"id":19653489,"url":"https://github.com/conventional-commits/php-commitizen","last_synced_at":"2025-04-06T23:17:36.122Z","repository":{"id":45118315,"uuid":"121778101","full_name":"conventional-commits/php-commitizen","owner":"conventional-commits","description":"PHP Commitizen - A CLI tool used to create commits according to Conventional Commits specification","archived":false,"fork":false,"pushed_at":"2022-09-07T21:07:59.000Z","size":41,"stargazers_count":111,"open_issues_count":4,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-09-19T11:44:24.635Z","etag":null,"topics":["commit","commitizen","conventional-changelog","conventional-commits","git","php","php-commitizen"],"latest_commit_sha":null,"homepage":"https://conventionalcommits.org/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/conventional-commits.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-16T17:15:53.000Z","updated_at":"2024-07-26T21:19:32.000Z","dependencies_parsed_at":"2022-08-26T10:41:21.042Z","dependency_job_id":null,"html_url":"https://github.com/conventional-commits/php-commitizen","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conventional-commits%2Fphp-commitizen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conventional-commits%2Fphp-commitizen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conventional-commits%2Fphp-commitizen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conventional-commits%2Fphp-commitizen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conventional-commits","download_url":"https://codeload.github.com/conventional-commits/php-commitizen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247563941,"owners_count":20958971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commit","commitizen","conventional-changelog","conventional-commits","git","php","php-commitizen"],"created_at":"2024-11-11T15:14:20.260Z","updated_at":"2025-04-06T23:17:36.097Z","avatar_url":"https://github.com/conventional-commits.png","language":"PHP","readme":"# PHP Commitizen\n\n[![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)\n[![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)\n[![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)\n\nCommitizen is a tool built for create good commits for a clean and readable git history.\n\nThis tool follow the [Conventional Commit specs](https://conventionalcommits.org/) and some best practices described in [this slides](https://slides.com/damianopetrungaro/working-with-git)\n\n# Installation and usage\n\nYou can install it easily with composer\n\n`$ php composer.phar require --dev damianopetrungaro/php-commitizen`\n\nUsage is simple too \n\n`$ php vendor/bin/php-commitizen commit`\n\nYou can also \n- pass a flag for add all the file to the stage: `-a` \n- specify a custom configuration file adding the file path as argument \n\nYou can ask for more information using: `$ php vendor/bin/php-commitizen commit --help`\n\n# Configuration file\n\nThe configuration file must return an array (or partial override)\n\n```\n\u003c?php\n\nreturn [\n    'type' =\u003e [\n        'lengthMin' =\u003e 1, // Min length of the type\n        'lengthMax' =\u003e 5, // Max length of the type\n        'acceptExtra' =\u003e false, // Allow adding types not listed in 'values' key\n        'values' =\u003e ['feat', 'fix'], // All the values usable as type\n    ],\n    'scope' =\u003e [\n        'lengthMin' =\u003e 0, // Min length of the scope\n        'lengthMax' =\u003e 10, // Max length of the scope\n        'acceptExtra' =\u003e true, // Allow adding scopes not listed in 'values' key\n        'values' =\u003e [], // All the values usable as scope\n    ],\n    'description' =\u003e [\n        'lengthMin' =\u003e 1, // Min length of the description\n        'lengthMax' =\u003e 44, // Max length of the description\n    ],\n    'subject' =\u003e [\n        'lengthMin' =\u003e 1, // Min length of the subject\n        'lengthMax' =\u003e 50, // Max length of the subject\n    ],\n    'body' =\u003e [\n        'wrap' =\u003e 72, // Wrap the body at 72 characters\n    ],\n    'footer' =\u003e [\n        'wrap' =\u003e 72, Wrap the footer at 72 characters\n    ],\n];\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconventional-commits%2Fphp-commitizen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconventional-commits%2Fphp-commitizen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconventional-commits%2Fphp-commitizen/lists"}