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 process guide for migrating packages into the core monorepo #2071

Merged
merged 21 commits into from
Nov 29, 2023

Conversation

MajorLift
Copy link
Contributor

@MajorLift MajorLift commented Nov 21, 2023

Explanation

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 and module-lint.

References

Changelog

N/A

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

@MajorLift MajorLift self-assigned this Nov 21, 2023
@MajorLift MajorLift force-pushed the 231120-migration-process-guide branch from d5bfdb5 to d6b1aa7 Compare November 22, 2023 01:40
@MajorLift MajorLift marked this pull request as ready for review November 22, 2023 01:40
@MajorLift MajorLift requested a review from a team as a code owner November 22, 2023 01:40
@MajorLift MajorLift force-pushed the 231120-migration-process-guide branch from d6b1aa7 to efa1d2f Compare November 22, 2023 01:43
@MajorLift MajorLift force-pushed the 231120-migration-process-guide branch from efa1d2f to 76aa46d Compare November 22, 2023 16:46
Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a lot of PRs to have to create for one package 😅 But it all makes sense, and it's nice that many of the PRs will be small.

Thanks for putting this together. This looks really comprehensive. I just had a few suggestions.

docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
mikesposito
mikesposito previously approved these changes Nov 29, 2023
Copy link
Member

@mikesposito mikesposito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Nice to see that you also have a detailed preparation phase to outline the steps to be performed prior to the migration, and that there are plenty of example PRs!

Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more thing but otherwise I think this is ready to go!

docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
docs/package-migration-process-guide.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@MajorLift MajorLift merged commit 2cfc957 into main Nov 29, 2023
132 checks passed
@MajorLift MajorLift deleted the 231120-migration-process-guide branch November 29, 2023 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document migration process for libraries moving to core monorepo
3 participants