MetaMask / MetaMask/metamask-extension

Evolve Changelog process

Open
#16,375 0 comments 0 reactions 0 assignees View on GitHub
needs-qa team-extension-platform
Dominant language
TypeScript
Stars
13.2k
Forks
5.6k
Avg merge
2d 5h
Merged PRs (30d)
451

Description

https://consensys.slack.com/archives/C03H9K48U2E/p1667557046364469

each PR author/team writes their own changelog entries on their corresponding PRs, instead of being us who re-write all PRs entries at the end?
I noticed this PR already added its corresponding entry on the Changelog, and after asking about it Mark mentioned this:
It is OK to add entries early though. When updating the changelog for an RC, the auto-changelog CLI tool should recognize the entry, migrate it into the new release section, and avoid adding a duplicate entry (it recognizes it by the referenced PR number).
So I think, the Release team could still run the auto-changelog script as the final verification step, but each PR author should already have added their corresponding entries inside their own PRs.
This would have some impact on the workflow that we have today, but I think might be worth to consider as it would remove some workload/responsibility on us, distributing it to each team.

https://github.com/MetaMask/metamask-extension/pull/16074#issuecomment-1302409180

Contributor guide

Open the contributing guide

Research direction

Review the linked Slack discussion and PR #16074 comment, then inspect how the auto-changelog CLI recognizes entries by referenced PR number. Done means the proposed author-owned changelog workflow and the release team's final verification process are clearly defined and agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.