You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Triaged this. This is still an issue. I still run into repos where I see people use changelogs incorrectly (they treat them as commit logs, they leave entries as Uncategorized, they leave in developer-only changes, they don't mention anything about the API, etc.).
I've been working on this off and on. I haven't been able to finish it yet. I'll revisit it when I get a chance.
Elliot Winkler commented: I haven’t worked on this since my last comment, but here’s where things sit.
I have a guide that I’ve been slowly writing. I’ve tried to paint a good picture of why changelogs are important and what engineers need to think about when they maintain them. However, I haven’t reached a point with the draft that I’m happy with. There are too many details.
Activity
mcmire commentedon Jul 9, 2025
Moving this back to "ready for dev" as I haven't worked on this in a while and am not sure when I will get back to this.
mcmire commentedon May 14, 2026
Triaged this. This is still an issue. I still run into repos where I see people use changelogs incorrectly (they treat them as commit logs, they leave entries as Uncategorized, they leave in developer-only changes, they don't mention anything about the API, etc.).
I've been working on this off and on. I haven't been able to finish it yet. I'll revisit it when I get a chance.
exalate-issue-sync commentedon May 19, 2026
Elliot Winkler commented: I haven’t worked on this since my last comment, but here’s where things sit.
I have a guide that I’ve been slowly writing. I’ve tried to paint a good picture of why changelogs are important and what engineers need to think about when they maintain them. However, I haven’t reached a point with the draft that I’m happy with. There are too many details.
I’ll try to return to this soon.