Skip to content

Simple php tool for checking commit message styleguides

License

Notifications You must be signed in to change notification settings

ApremierA/php-commit-message-check

 
 

Repository files navigation

commit-message-check

Build Status

Простая утилита для проверки коммит-сообщения на соответствие некоторым нормам:

  • Сообщение должно состоять из заголовка и содержимого, отделённого пустой строкой
  • Заголовок должен начинаться с заглавной буквы
  • Заголовок не должен быть в длину не более 50 символов
  • Заголовок не должен заканчиваться точкой
  • Содержимое должно начинаться с заглавной буквы
  • Содержимое должно заканчиваться точкой

Для установки утилиты, выполните команду

composer global require "chshanovskiy/commit-message-check=dev-master"

После этого, добавьте в переменную окружения PATH путь до исполняемых файлов композера (обычно $HOME/.composer/vendor/bin), и вам станет доступна команда commit-message-check

Запустите её без параметров, и она выдаст вам команды, которые необходимо выполнить, чтобы назначить её как глобальный хук commit-msg. Выполните эти команды и начинайте писать коммиты.

About

Simple php tool for checking commit message styleguides

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%