Uh oh!
There was an error while loading. Please reload this page.
chore: Simplify docs for package migration process - #8818
Conversation
The package migration process doc has been updated to remove some steps that we've been skipping during recent migrations (migrating the changelog and tags), and it has been updated to reflect changes in how the monorepo is currently setup.
| @@ -1,6 +1,6 @@ | |||
| # Package migration process guide | |||
| This document outlines the process for migrating a MetaMask library into the core monorepo. The migration target is assumed to comply with the requirements defined by [`metamask-module-template`](https://github.com/MetaMask/metamask-module-template) and [`module-lint`](https://github.com/MetaMask/module-lint). | |||
There was a problem hiding this comment.
I'm not sure that module-lint is still up-to-date, and we don't actively use it anymore, so I've omitted it here.
| - [Example PR](https://github.com/MetaMask/eth-json-rpc-provider/pull/38) | ||
| ### 2. Add the source repo to the ZenHub workspace repo filter so that its issues/PRs show up on the board |
There was a problem hiding this comment.
This is no longer relevant since we no longer use ZenHub.
| - [Example PR](https://github.com/MetaMask/core/pull/1872) | ||
| ### **[PR#7]** 2. Update the CHANGELOG tag diff links so that they follow the core repo's tag naming convention |
There was a problem hiding this comment.
These two steps have been replaced by the "Reset changelog" step
| - If it's external, bump only if there are no resulting breaking changes that need to be resolved. | ||
| - [Example PR](https://github.com/MetaMask/core/pull/1766) | ||
| ### **[PR#11]** 7. Add exception for non-MIT license |
There was a problem hiding this comment.
The constraints we use now require that some license is set, and it does suggest MIT if it's missing, but we don't enforce that MIT is used.
Gudahtt
commented
May 14, 2026
I didn't thoroughly check the doc for outdated instructions. I just fixed the ones I noticed. Hopefully this is at least a step forward. We can do a more thorough update the next time we find ourselves following this process. |
Explanation
The package migration process doc has been updated to remove some steps that we've been skipping during recent migrations (migrating the changelog and tags), and it has been updated to reflect changes in how the monorepo is currently setup.
References
N/A
Checklist
Note
Low Risk
Documentation-only updates that adjust the recommended migration steps; no runtime code or behavior changes.
Overview
Simplifies
docs/processes/package-migration-process-guide.mdby removing guidance around migrating/porting tags and validating changelog compare links, replacing it with a new step to reset the migrated package CHANGELOG and link back to the old repo.Updates the preparation checklist to include
Oxfmt, drops themodule-lintrequirement reference, and renumbers/reorders PR steps throughout the guide to reflect the streamlined process.Reviewed by Cursor Bugbot for commit 7ed8f75. Bugbot is set up for automated code reviews on this repo. Configure here.