This is great, thanks Kunal, Bryan and Fabian :)
On Tue, Nov 7, 2017 at 11:28 AM, Kunal Mehta legoktm@member.fsf.org wrote:
Hi!
tl;dr https://www.mediawiki.org/wiki/commit-message-validator
Commit messages are pretty important - they make it easy to figure out what a change does without reading the entire diff. And because of that, we have some guidelines[1] on how to format your commit message in the standard way.
But sometimes people aren't familiar with the guidelines, or more likely we make a typo somewhere. Here's where the commit-message-validator[2] comes in handy!
$ git commit
<type in commit message and save> commit-message-validator v0.5.1 The following errors were found: Line 1: First line should be <=80 characters Line 3: Bug: value must be a single phabricator task ID Please review <https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines> and update your commit message accordingly
Or if you did a good job: commit-message-validator v0.5.1 Commit message is formatted properly! Keep up the good work!
Installing it as a git hook is the recommended usage, and instructions on the wiki page[2] explain how to do so, even for people who aren't familiar with Python.
The tool was written by Bryan Davis, Fabian Neundorf, and myself. Bugs/feature requests can be filed in the Phabricator project.
[1] https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines [2] https://www.mediawiki.org/wiki/Commit-message-validator
-- Legoktm
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l