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

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

Merged
merged 4 commits into from
May 17, 2024

Conversation

georgewrmarshall
Copy link
Collaborator

@georgewrmarshall georgewrmarshall commented May 16, 2024

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

before720.mov

After

after720.mov

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained what problem this PR is solving and how it is solved.
  • I've linked related issues
  • I've included manual testing steps
  • I've included screenshots/recordings if applicable
  • 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.
  • I’ve properly set the pull request status:
    • In case it's not yet "ready for review", I've set it to "draft".
    • In case it's "ready for review", I've changed it from "draft" to "non-draft".

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@georgewrmarshall georgewrmarshall self-assigned this May 16, 2024
@georgewrmarshall georgewrmarshall added the team-design-system All issues relating to design system label May 16, 2024
@georgewrmarshall georgewrmarshall marked this pull request as ready for review May 16, 2024 23:19
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner May 16, 2024 23:19
@@ -73,7 +74,7 @@ Currently the metamask design tokens repo supports 2 formats, CSS-in-JS and CSS
```js
import { lightTheme, darkTheme } from '@metamask/design-tokens';

// Create provider that swaps theme (sudo code)
// Create provider that swaps theme (pseudo code)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

spelling error fix

Copy link
Contributor

Choose a reason for hiding this comment

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

nice

@metamaskbot
Copy link
Collaborator

Builds ready [69e7a93]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [1291290]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [7acd51a]

Storybook: Storybook

@brianacnguyen brianacnguyen merged commit b315c2b into main May 17, 2024
19 checks passed
@brianacnguyen brianacnguyen deleted the docs/640/add-tooling-section branch May 17, 2024 16:24
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 this pull request may close these issues.

Add "Tooling" Section to Promote eslint-plugin-design-tokens Usage
4 participants