[vtk-developers] Thoughts on changelog maintenance?
Ben Boeckel
ben.boeckel at kitware.com
Tue Nov 7 14:10:35 EST 2017
Hi all,
With 8.1.0 recently starting its RC cycle and the changelog request
emails being sent, what would thoughts be on having changelogs be part
of merge requests directly starting with the 9.0 development cycle?
There are two general ways of doing this:
- a single file that gets updated by each MR.
- a directory of files, one per changelog entry.
The first is probably not fit for VTK due to the volume of changes that
it receives and it would be a never-ending cause of conflicts. The
latter would be either markdown or restructured text files. VTK seems to
have more `.md` files than others right now, so that would probably work
out better. How about putting them in `Documentation/release/dev`?
The robot can warn (or enforce, but, IMO, that shouldn't be done) about
missing changelogs on a topic level. Would that be something that we
should enable?
--Ben
More information about the vtk-developers
mailing list