chore: Introduce a Changelog #2084
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Maintainers agreed to try the changelog out in the 2023-02-13 occurrence of the go-libp2p triage meeting, so I'm merging this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In a draft for a discussion.
I like the idea of having a changelog file in the repo that can be updated as features are rolled out. Kubo does this and rust-libp2p does this. The less work we can do at release time the better. Ideally releases should feel almost like a no-op.
For the initial version, I copied the release notes from the tracking issue. In the future, I imagine the tracking issue is used as coordination/planning (as it's done today) and breaking changes/features are added in the changelog as we go. This can then be copy/pasted into the release notes.
I would also like to see the semantic PR titles being used to highlight breaking changes and such. But that's somewhat orthogonal to this change.