[vtk-developers] Thoughts on changelog maintenance?

[Elvis Stansvik]

2017-11-07 20:10 GMT+01:00 Ben Boeckel <ben.boeckel at kitware.com>:
> 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`?

Personally I always start hunting for the ChangeLog at the top-level,
next to the README. But maybe you'd like to keep the top-level as
clean as possible?

One thing I thought of: Perhaps CPython's way of handling it's NEWS
file could offer some inspiration?
(https://pypi.python.org/pypi/blurb). (It just struck me, since I
recently had to dabble with that one).

Elvis

>
> 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
> _______________________________________________
> 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
>