Improve documentation of new features in Changelog

gazebosim / sdformat

Simulation Description Format (SDFormat) parser and description files.

http://sdformat.org

Apache License 2.0

166 stars 92 forks source link

Improve documentation of new features in Changelog #1353

Open scpeters opened 9 months ago

scpeters commented 9 months ago

Desired behavior

Our Changelog currently has a list of pull requests included in each release with the pull request title, but it would be helpful to include more information about significant features included in each release. This could be included in the Changelog file itself and/or in the GitHub release page.

Alternatives considered

Implementation suggestion

Additional context

azeey commented 8 months ago

One option would be to adopt Conventional Commits. We can then use tools like https://git-cliff.org/ to generate more structured changelogs.