[vtk-developers] Commit log guidelines

Utkarsh Ayachit utkarsh.ayachit at kitware.com
Tue May 17 12:15:22 EDT 2016


Folks,

I recently came across this: http://chris.beams.io/posts/git-commit/

Any thoughts on adopting this as a style guide? The rules are:

1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how

I think (7) really brings it home, although I wonder if a short "how"
can also be included.

Utkarsh


More information about the vtk-developers mailing list