Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 3.63 KB

CODING_GUIDELINES.md

File metadata and controls

64 lines (50 loc) · 3.63 KB
Raw

MetaMask Coding Guidelines

1. New Code Should be TypeScript

  • New components and utilities should be written in TypeScript and enforce typing.
  • Existing code should be refactored into TypeScript where time allows. If you are replacing a component, use TypeScript.
  • Follow contributor doc TypeScript Guidelines.

2. Using Functional Components and Hooks Instead of Classes

  • Use functional components and hooks as they result in more concise and readable code compared to classes.

3. Organize Files Related to the Same Component in One Folder

  • An example of a component file structure:
avatar-account
├── avatar-account.stories.tsx
├── avatar-account.scss
├── avatar-account.test.tsx
├── avatar-account.tsx
├── avatar-account.types.ts
├── README.md
├── __snapshots__
│   └── avatar-account.test.tsx.snap
└── index.ts

4. Follow Naming Conventions

  • You should always use PascalCase when naming components. For example: TextField, NavMenu, and SuccessButton.
  • Use camelCase for functions declared inside components like handleInput() or showElement().
  • When creating hooks use withHookName().

5. Avoid Repetitive Code

  • If you notice you are writing duplicated code or components, convert it into a component, utility functions or hooks that can be reused. Do this with scalable intention.

6. Component Optimization

  • For functional components, instead of having large return statements, breaking the component down into smaller sub-components.
  • Use memoizing techniques where possible. Utilize the useMemo hook for values and useCallback for functions. Follow recommended React guidance.
  • Use the useEffect hook for performing side effects like data fetching or DOM manipulation after the component has rendered. However, use it judiciously as unnecessary effects can complicate code and affect performance. For a deeper understanding, we recommend reading this article.

7. Use Object Destructuring For Props

  • Instead of passing the props object, use object destructuring to pass the prop name. This discards the need to refer to the props object each time you need to use it.
import React from 'react';
const MyComponent = ({ id }) => {
  return <div id={id} />;
};

8. Document Each Component/Utility

  • New utility functions should be documented TSDoc commenting format.
  • Referencing our component docs.
  • If applicable add URL to online resources if they are meaningful for the component/method.

9. Write Tests for Each Component/Utility

  • Write tests for the components you create as it reduces the possibilities of errors. Testing ensures that the components are behaving as you would expect. In this project Jest is used, and it provides an environment where you can execute your tests.
  • Follow the contributor docs Unit Testing Guidelines.

10. External packages should be well maintained

  • New packages should only be integrated if the application doesn’t have the existing functionality and it cannot be added by implementing a small utility function. Use the https://snyk.io/advisor/ to assess the popularity, maintainability and security analysis. The package must be in good standing to be added to the project.
  • Update existing dependencies when you notice they are out of date.

Source