Commit-message-validator/en

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
English • ‎español • ‎français • ‎português • ‎русский • ‎српски / srpski • ‎中文 • ‎日本語

commit-message-validator is a tool that validates commit messages to our commit message guidelines. It requires Python 3.3+ or 2.7. The preferred method of installation is to use a virtualenv and git hooks.

# Create a new virtualenv in the directory "cmv" in your home directory
cd ~
virtualenv cmv
# Install from pypi
~/cmv/bin/pip install commit-message-validator
# Configure the git hook. You'll need to do this for every git repo you wish to run it on
cd /path/to/git/repository
~/cmv/bin/commit-message-validator install

# to update to the latest release
~/cmv/bin/pip install -U commit-message-validator

The git hook will run after you make the commit, and tell you about any errors you might have made so you can go back and amend your change.

External links