[vtk-developers] Thoughts on changelog maintenance?

[Brad King]

On 11/07/2017 02:10 PM, Ben Boeckel wrote:
>   - a directory of files, one per changelog entry.
> ...
> How about putting them in `Documentation/release/dev`?

To clarify, changelog entries during development would be put in
files in that directory.  Then at release time they will be
consolidated into a single file for that release.  Then the
directory would be used to collect changelog entries for the
next release.  CMake does this for its release notes.

So:

- `Documentation/release/dev/$topic.md` files have changelog
  entries for new development since the last release.

- `Documentation/release/$version.md` has consolidated changelog
  entries for release $version when released.

The latter could be put in other places, like a top-level
`CHANGELOG.md` file, since it is consolidated and curated by hand.

-Brad