Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release notes document #425

Closed
traversaro opened this issue Jun 3, 2019 · 2 comments
Closed

Add release notes document #425

traversaro opened this issue Jun 3, 2019 · 2 comments

Comments

@traversaro
Copy link
Member

To better document the new releases, we should add and maintain a releases notes/change log document to the repo.
As I worked a bit with the multi-file structure of the release notes in YARP ( https://github.com/robotology/yarp/tree/master/doc/release ) and iDynTree ( https://github.com/robotology/idyntree/tree/master/doc/releases ), I think that having a separate file for each release add quite a bit of overhead for each release, especially if the release is done via the the GitHub's web interface. For this reason, for this repo I would like to try to use a single document for all the release notes, with different section for each release, something like what is documented in https://keepachangelog.com/en/1.0.0/ .

@traversaro
Copy link
Member Author

traversaro commented Jun 3, 2019

Example of the format for the next feature release:

[3.2.0] - 2019-06-24

Added

Fixed

@traversaro
Copy link
Member Author

Done in #432 .

@traversaro traversaro self-assigned this Jul 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant