Changelog and communication
Since now only occasionally involved in the project, I notice something that could improve the overall project health of FluidDyn.
The good
With the merge request based workflow, things are a bit more cohesive than it used to be. Thanks to Heptapod, I can follow the development via this page: https://foss.heptapod.net/groups/fluiddyn/-/activity.
The bad
Changelog for some recent releases are too short. See fluidfft 0.3.1 and transonic 0.4.3 for instance, which is a variation of "various bug fixes". It does not help the reader.
What can change
Project maintainance is a tough job already. I understand. But one could produce better changelogs. Some solutions
-
towncrier
is a package which assists developers in this regard. I have not used it personally, but looks like NumPy has adopted it. - Keep a changelog has a nice template for clearly defining what has changed. It also helps in deciding whether the next release would be a major / minor / patch release.
Once this improved changelog is ready and a new version is out, send it out to the mailing list. Then, tweet the link to the mailing list archive so that others know about it.
To Do
-
fluidsim -
fluidfft -
fluidimage -
fluidlab
pyproject.toml pending
-
fluidsht -
transonic