Add guidelines for maintaining changelogs #121
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
mcmire
force-pushed
the
add-changelogs-guidelines
branch
3 times, most recently
from
965b082 to
34c5980
Compare
mcmire
changed the title
Changelogs seem straightforward enough to maintain, but recent updates in the `core` repo indicate that there may be misconceptions. The guidelines in this PR aim to clarify the purpose of a changelog and how to maintain them so that they are valuable for consumers at all times. This is a prequisite for updating the release process in the `core` monorepo but should prove valuable in many other MetaMask projects as well.
mcmire
force-pushed
the
add-changelogs-guidelines
branch
from
34c5980 to
c70d08a
Compare
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.
Changelogs seem straightforward enough to maintain, but recent updates in the
corerepo indicate that there may be misconceptions around them. The guidelines in this PR aim to clarify the purpose of a changelog and how to maintain them so that they are valuable for consumers at all times.This is a prequisite for updating the release process in the
coremonorepo but should prove valuable in many other MetaMask projects as well.📖 View rendered document
Closes #122.