Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Add migration notice to design-tokens repo #743

Closed
4 tasks
georgewrmarshall opened this issue Nov 8, 2024 · 0 comments · Fixed by #742
Closed
4 tasks

Add migration notice to design-tokens repo #743

georgewrmarshall opened this issue Nov 8, 2024 · 0 comments · Fixed by #742
Assignees
Labels
team-design-system All issues relating to design system

Comments

@georgewrmarshall
Copy link
Collaborator

Description

Add a migration notice to the top of the repository README to inform developers that this package is currently being migrated to the metamask-design-system monorepo. This notice helps to prevent any unintended commits or PRs in the source repository during the migration phase, directing active development to the new monorepo location.

Technical Details

  • Place the migration notice in a table at the very top of the README.
  • Ensure that the message is clearly visible and links directly to the metamask-design-system monorepo.
  • The notice should advise developers to avoid commits in the source repository and to re-open active PRs in the new repository.

The migration notice content:

<table><tr><td><p align="center"><b>⚠️ PLEASE READ ⚠️</b></p><p align="center">This package is currently being migrated to our <a href="https://github.com/MetaMask/metamask-design-system"><code>metamask-design-system</code></a> monorepo. Please do not make any commits to this repository while this migration is taking place, as they will not be transferred over. Also, please re-open PRs that are under active development in the metamask module template.</p></td></tr></table>

Acceptance Criteria

  • Migration notice is added to the top of the README.
  • Notice links correctly to the metamask-design-system monorepo.
  • Notice discourages further commits in this repository during migration.
  • PRs under active development are advised to re-open in the new repository.

References

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
team-design-system All issues relating to design system
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant