Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

57 lines (34 loc) · 1.75 KB
Raw

Contributing

First off, thanks for taking some time to contribute! 🎉👍

This file will guide you through the local setup and contains the guidelines you will need to follow to get your code merged.

Guidelines

Requirements

In order to get merged, a pull request must:

  • Pass the linter (pnpm ui:react lint)
  • Pass the typechecker (pnpm ui:react typecheck)

If you are using VSCode, you can use the eslint and prettier plugins to auto-format your code on save.

Code practices

  • Export your components and make them consumable from the root.

The components should be importable from @ledgerhq/react-ui, so do not forget to add export statements in the src/components/index.ts file.

  • Export required typescript types.

Types should also be importable (but not from root because of name conflicts!).

  • If you are creating a new component you should write a related storybook story.

  • Avoid non-standard imports in the code (.png, .svg…).

The library is agnostic, it does not make any assumptions on the consumer setup and will not force the use of any kind of non-standard bundler.

  • Avoid installing new packages unless necessary.

To keep the dependencies short and the size small.

Local development

If you need to use the locally installed version of this package, you will need to perform the following steps.

## From the root of the monorepo:

# Build the react components library and its dependencies.
pnpm turbo build --filter=@ledgerhq/react-ui
## From the repository that consumes @ledgerhq/react-ui:

# Replace [path/to/ui] with the relative path to the local ui repo.
# You should be able use any package manager instead of pnpm here.
pnpm add [path/to/ui]/packages/react/lib