unl-nimbus-lab / pymavswarm

Python library used to safely control drone swarms and drone fleets with MAVLink

Home Page:https://pymavswarm.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[FEATURE]: Integrate `CHANGELOG` with towncrier

evan-palmer opened this issue · comments

Is your feature request related to a problem? Please describe

There is currently no documentation regarding the changes made at each release. This makes it difficult for users to know what new features exist and what bugs have been squashed.

Describe the solution you'd like

Add a project CHANGELOG. To avoid CHANGELOG conflicts, it would also be helpful to integrate towncrier. This will help with automatic documentation as well.

Describe alternatives you've considered

Rather than maintaining a CHANGELOG, documentation could also be added to each version released. However, this solution requires much more manual work than may be desired.

Implementation Ideas

Integrate a towncrier configuration to automatically document and generate a CHANGELOG

Additional context

Relevant links: