MetaMask / design-tokens

Design tokens to be used throughout MetaMask products
https://metamask.github.io/design-tokens/?path=/docs/getting-started-introduction--docs
28 stars 15 forks source link

docs: updating readme to add tooling section that links to eslint-plugin #689

Closed georgewrmarshall closed 4 months ago

georgewrmarshall commented 4 months ago

Description

This pull request updates the README file to include a new section on tooling, specifically adding a reference to eslint-plugin. The motivation behind this change is to provide developers and contributors with quick access to the tools we use for maintaining code quality. This addition will help new contributors set up their development environments more efficiently.

Related issues

Fixes: #640

Manual testing steps

  1. Open the README file.
  2. Verify that the new section on tooling is present and includes a link to eslint-plugin.
  3. Ensure the link is correctly formatted and accessible.

Screenshots/Recordings

Before

https://github.com/MetaMask/design-tokens/assets/8112138/ae20cd7c-a283-4b84-a3b5-4ec7cd85ab87

After

https://github.com/MetaMask/design-tokens/assets/8112138/04ae27cc-4bbc-45a4-bdd5-bcc3a4a19790

Pre-merge author checklist

Pre-merge reviewer checklist

metamaskbot commented 4 months ago

Builds ready [69e7a93]

Storybook: Storybook

metamaskbot commented 4 months ago

Builds ready [1291290]

Storybook: Storybook

metamaskbot commented 4 months ago

Builds ready [7acd51a]

Storybook: Storybook