Add guidelines for maintaining changelogs

Open
#122 3 comments 0 reactions 1 assignee View on GitHub

@mcmire is already working on this.

Since Jan 6, 2025.

Assessment

This issue has not been assessed yet.

Description

category-documentation github-migration-triaged team-wallet-framework wf-documentation

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.

Dominant language
JavaScript
Stars
86
Forks
42
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MetaMask/contributor-docs

All issues in MetaMask/contributor-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.