[vtk-developers] [EXTERNAL] Commit log guidelines

Tue May 17 16:21:48 EDT 2016

Compare the last 20 commit subjects (removed Merge) for vtk and itk
ITK-----------------------------------
ENH: Reduce number of dependencies for XML files generated for wrapping
ENH: CovariantVector's Normalize returns the norm.
COMP: Update CastXML to support Visual Studio 2015 Update 2.
VNL 2016-04-26 (6b168535)
BUG: Wrapping intermediate files were not automatically updated
COMP: Do not set wrapping library visibility with static builds.
COMP: Update CastXML to support Visual Studio 2015 Update 2.
ENH: Test address of NumericTraits One and Zero constexpr
BUG: Don't use "=" in cmake variable name
STYLE: Use consistent path for try_compiles binary directory
ENH: Prefer ZeroValue function over variable
ENH: Deprecate MaskLabel in N4BiasFieldCorrectionImageFilter.
COMP: Hack HDF5 to build under ASan & UBSan
BUG: Increase MaskLabel backwards compatibility in N4 bias correction.
ENH: Use argparse instead of optparse in igenerator.py
ENH: switch gdcm to release branch, not release-2-4
BUG: Initialize azimuth and elevation to pi/2 in PhasedArray3D.
BUG: Prevent division by zero in PhasedArray3DSpecialCoordinatesImage.
COMP: Fix RayCastInterpolateImageFunction wrapping for image dim 2

VTK------------------------
Adding tools for efficient file system introspection.
Clean up character array in test.
Add missing return statement to NULL check.
wrap function signatures longer than 80 characters
Fixed return type of various comparison operators from int to bool
Fixed cppcheck knownConditionTrueFalse warnings
Fixed cppcheck unsignedLessThanZero warning
Fixed all cppcheck operatorEq warnings
fix for recently renamed enum
limit comments to ASCII characters, to prevent encoding issues
fix class references in vtkDataObject's documentation
Fixes culling in GPURayCast.
vtkFFMPEGWriter: Fix build with libavcodec57
vtkFFMPEGWriter: Use avformat_write_header return value
ENH: Improve coverage of vtkGenericGeometryFilter
Replace SafeDownCast calls on arrays with vtkArrayDownCast.
Allow NULL inputs to array FastDownCast methods.
use enum for FlyModes in vtkCubeAxesActor2D.h
ibo creation was not setting Index to zero when no cells
Fix vtkPolyData Reset

On Tue, May 17, 2016 at 3:25 PM, Marcus D. Hanwell
<marcus.hanwell at kitware.com> wrote:
> I agree with Rob, try to keep it to 40/50, but longer should be OK. I
> tend to stick to thinking of that as the email subject, leave the
> blank line and then write something similar to a mailing list post
> explaining what I did and why (assuming you can look at the diff for
> how).
>
> I think these are good general guidelines, maybe settling on a tense
> is nice but I don't get hung up about it. If it is simple then no body
> should be OK too.
>
> On Tue, May 17, 2016 at 2:22 PM, Robert Maynard
> <robert.maynard at kitware.com> wrote:
>> 50 characters is limiting if you want to list the class names in the
>> subjects. I currently think the limit of 68/69 is more reasonable.
>>
>>
>>
>> On Tue, May 17, 2016 at 1:05 PM, Scott, W Alan <wascott at sandia.gov> wrote:
>>> Nice.
>>>
>>> I would think that your last sentence, "How", depends on the code.  If there are non-obvious side effects of the bug or fix, explain how the code works and/or the fix works.  For subtle performance work (change taking cosine of a constant to a constant, used in bottom of loops), how can be invaluable.  But for simple, clear code, how probably isn't needed.
>>>
>>> Alan
>>>
>>> -----Original Message-----
>>> From: vtk-developers [mailto:vtk-developers-bounces at vtk.org] On Behalf Of Utkarsh Ayachit
>>> Sent: Tuesday, May 17, 2016 10:15 AM
>>> To: vtk-developers at vtk.org
>>> Subject: [EXTERNAL] [vtk-developers] Commit log guidelines
>>>
>>> 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
>>>
>>> _______________________________________________
>>> 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
>>>
>> _______________________________________________
>> 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
>>
> _______________________________________________
> 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