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

Change log is chaotic and partly uninformative #1129

Open
opcode81 opened this issue Apr 29, 2024 · 2 comments
Open

Change log is chaotic and partly uninformative #1129

opcode81 opened this issue Apr 29, 2024 · 2 comments

Comments

@opcode81
Copy link
Collaborator

opcode81 commented Apr 29, 2024

Changes pertaining to the same component are not grouped.
I would recommend a more hierarchical change log, where we group all changes according to the function/module/class they pertain to. The first change in a component establishes a bullet item and further changes in the same component change the entry to use sub-items.
This will make it much easier for a reader to determine which changes are relevant to them.

Some changes would benefit from a more detailed description. Reviewers should require good descriptions from contributors.

v1.0.0 should probably appear in the change log along with the release date.

We should also make clear that the topmost version is unreleased for clarity, i.e. "v1.1.0 (unreleased)", and then add the actual date once it's released.

opcode81 added a commit to aai-institute/tianshou-fork that referenced this issue Apr 30, 2024
@MischaPanch
Copy link
Collaborator

I structured it a bit in this commit

@MischaPanch
Copy link
Collaborator

Noticed too late that you also structured it on another branch :(. Gonna clean up the conflict

MischaPanch added a commit that referenced this issue May 5, 2024
…1131)

Description of changes: see individual commits; merged without squashing.

Co-authored by: @maxhuettenrauch 

Partly addressed #1129
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

2 participants