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

Latest commit

 

History

History
62 lines (40 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.07 KB
Raw

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.

Development workflow

To get started with the project, run npm install in the root directory to install the required dependencies for each package:

npm install

Make sure your code passes TypeScript and ESLint. Run the following to verify:

npm run watch
npm run lint

To fix formatting errors, run the following:

npm run lint --fix

To use prettier, run the following:

npm run format

Linting and tests

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.

Our pre-commit hooks verify that the linter and tests pass when committing.

Scripts

The package.json file contains various scripts for common tasks:

  • npm run watch: type-check files with TypeScript.
  • npm run lint: lint files with ESLint.
  • npm run format: format files with Prettier.
  • npm run dev: run the dashboard in development mode.
  • npm run build: build the dashboard for production.

Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that linters and tests are passing.
  • Review the documentation to make sure it looks good.
  • Follow the pull request template when opening a pull request.
  • For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.