Commit 6935cb04 authored by Cory Quammen's avatar Cory Quammen
Browse files

Add description of commit message requirements

Currently, there are no formal requirements for commit messages.
This is a step toward requirements without getting too formal.
parent 7a7fb98a
Pipeline #2144 passed with stage
......@@ -36,6 +36,10 @@ for additional information.
$ git add file1 file2 file3
$ git commit
Commit messages must be thorough and informative so that
reviewers will have a good understanding of why the change is
needed before looking at the code.
For more information see: [Create a Topic][]
6. Push commits in your topic branch to your fork in GitLab:
......
......@@ -117,6 +117,15 @@ A reader should have a general idea of the feature or fix to be developed given
* To add data follow [these instructions](https://gitlab.kitware.com/vtk/vtk/blob/master/Documentation/dev/git/data.md),
from VTK.
Commit messages must contain a brief description as the first line
and a more detailed description of what the commit contains. If
the commit contains a new feature, the detailed message must
describe the new feature and why it is needed. If the commit
contains a bug fix, the detailed message must describe the bug
behavior, its underlying cause, and the approach to fix it. If the
bug is described in the bug tracker, the commit message must
contain a reference to the bug number.
Share a Topic
-------------
......
  • mentioned in commit d9a81dc8

    Toggle commit list
  • Added a plugin to read ICON netCDF files based on a CDI Reader developed at the MPI-M in Hamburg Germany. ICON netCDF data is similar to MPAS and the data is used in climate science visualization. The reader is based on the vtkUnstructuredGrid class.

Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment