Previous: , Up: Editing Commit Messages   [Contents][Index]

Commit Message Conventions

Git-Commit highlights certain violations of commonly accepted commit message conventions. Certain violations even cause Git-Commit to ask you to confirm that you really want to do that. This nagging can of course be turned off, but the result of doing that usually is that instead of some code it’s now the human who is reviewing your commits who has to waste some time telling you to fix your commits.

User Option: git-commit-summary-max-length

The intended maximal length of the summary line of commit messages. Characters beyond this column are colorized to indicate that this preference has been violated.

User Option: git-commit-finish-query-functions

List of functions called to query before performing commit.

The commit message buffer is current while the functions are called. If any of them returns nil, then the commit is not performed and the buffer is not killed. The user should then fix the issue and try again.

The functions are called with one argument. If it is non-nil then that indicates that the user used a prefix argument to force finishing the session despite issues. Functions should usually honor this wish and return non-nil.

By default the only member is git-commit-check-style-conventions.

Function: git-commit-check-style-conventions

This function checks for violations of certain basic style conventions. For each violation it asks users if they want to proceed anyway.

User Option: git-commit-style-convention-checks

This option controls what conventions the function by the same name tries to enforce. The value is a list of self-explanatory symbols identifying certain conventions; non-empty-second-line and overlong-summary-line.

Previous: Commit Mode and Hooks, Up: Editing Commit Messages   [Contents][Index]