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 guidelines for maintaining changelogs #122

Open
mcmire opened this issue Jan 6, 2025 · 0 comments · May be fixed by #121
Open

Add guidelines for maintaining changelogs #122

mcmire opened this issue Jan 6, 2025 · 0 comments · May be fixed by #121
Assignees

Comments

@mcmire
Copy link
Contributor

mcmire commented Jan 6, 2025

Currently we do not have enough documentation on changelogs: what format we follow, why they are useful, and how to keep them in good shape. We have found especially on the Wallet Framework side that as more people contribute to the core repo they often group too many entries together when they should split them up, they don't provide enough detail around API changes, they include developer-only changes, or they allow commit messages to get copied straight over (along with Conventional Commit prefixes) without rewording them.

We ought to document all of the guidelines we internally follow so that anyone who updates a changelog in any MetaMask project can make use of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants
@mcmire and others