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.

Sign up for GitHub

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

Jump to bottom

Document migration process for libraries moving to core monorepo #1832

Closed
2 of 7 tasks
desi opened this issue Oct 12, 2023 · 0 comments · Fixed by #2071
Closed
2 of 7 tasks

Document migration process for libraries moving to core monorepo #1832

desi opened this issue Oct 12, 2023 · 0 comments · Fixed by #2071
Assignees
@MajorLift
Labels
team-wallet-framework

Comments

@desi
Copy link
Contributor

desi commented Oct 12, 2023 •
edited by MajorLift
Loading

Overview

As part of Shared Libraries Q3/Q4 OKRs, the team would like to document a process guide for migrating libraries into this monorepo.

This process guide is intended to be a comprehensive step-by-step manual that is granular and streamlined enough to be easily followed by the team to migrate libraries into the core monorepo without significant adjustments or delays.

Tasks

  • Break down the required actions into granular, orthogonal PRs.
  • Map out a preferred order and grouping for executing these tasks.
  • Compile a comprehensive, standardized process guide.
  • Include notes regarding points of caution, reasoning behind instructions, possible alternatives, etc.

Blocked by

References
@MajorLift MajorLift mentioned this issue Oct 12, 2023
Closed
9 tasks
@MajorLift MajorLift mentioned this issue Nov 21, 2023
Merged
3 tasks
MajorLift added a commit that referenced this issue Nov 29, 2023
@MajorLift @mcmire
Add process guide for migrating packages into the core monorepo (#2071)
2cfc957 
## 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`](https://github.com/MetaMask/metamask-module-template)
and [`module-lint`](https://github.com/MetaMask/module-lint).

## References

- Closes #1832

## Changelog

N/A

## Checklist

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

---------

Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MajorLift MajorLift

Labels
team-wallet-framework
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add process guide for migrating packages into the core monorepo MetaMask/core
2 participants
@desi @MajorLift