[vtk-developers] Commit log guidelines

Bill Lorensen bill.lorensen at gmail.com
Tue May 17 12:51:37 EDT 2016


I still add a prefix to the message like ENH: BUG: COMP: DOC:.

Makes it easy to scan the topics. We still require that in ITK. For
some reason we dropped it for VTK.

Bill

On Tue, May 17, 2016 at 12:15 PM, Utkarsh Ayachit
<utkarsh.ayachit at kitware.com> wrote:
> 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
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Search the list archives at: http://markmail.org/search/?q=vtk-developers
>
> Follow this link to subscribe/unsubscribe:
> http://public.kitware.com/mailman/listinfo/vtk-developers
>



-- 
Unpaid intern in BillsBasement at noware dot com


More information about the vtk-developers mailing list