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

chore: updating design-tokens readme to align with other packages #124

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

georgewrmarshall
Copy link
Contributor

@georgewrmarshall georgewrmarshall commented Nov 16, 2024

Description

This PR updates the README for the Design Token Package to align with its new status as a non-root package in the design system monorepo. This change follows the package migration process guide and standardizes the README structure, making it consistent with other non-root packages in the monorepo.

Related issues

Fixes: #123

Manual testing steps

  1. Navigate to the README of the Design Token Package.
  2. Confirm that the Introduction, Installation, Usage, and Contributing sections are present and follow the monorepo's standard structure.
  3. Verify that instructions on development tasks (e.g., Test, Build) are removed.

Screenshots/Recordings

Before

before720.mov

After

after720.mov

Pre-merge author checklist

  • I’ve followed MetaMask Contributor Docs.
  • I’ve completed the PR template to the best of my ability.
  • I’ve included tests if applicable.
  • I’ve documented my code using JSDoc format if applicable.
  • I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

  • I’ve manually tested the PR (e.g., pull and build branch, run the app, test code changes).
  • I confirm that this PR addresses all acceptance criteria and includes necessary testing evidence, such as recordings or screenshots.

@georgewrmarshall georgewrmarshall self-assigned this Nov 16, 2024
@georgewrmarshall georgewrmarshall changed the title chore: updating readme to align with other packages chore: updating design-tokens readme to align with other packages Nov 16, 2024
@georgewrmarshall georgewrmarshall marked this pull request as ready for review November 16, 2024 00:16
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner November 16, 2024 00:16
@georgewrmarshall
Copy link
Contributor Author

@metamaskbot publish-preview

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.

Update design tokens readme
1 participant