Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 1.53 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on GitHub.

Informal discussion regarding bugs, new features, and implementation of existing features takes place in the GitHub issue page.

Pull Requests

  • Lint your code. Make sure your code follows our coding standards by running pnpm lint on the CLI.

  • Add tests! Your patch won't be accepted if it does not have tests.

  • Document any change in behaviour. Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Create feature branches. Don't ask us to pull from your master branch.

  • One pull request per feature. If you want to do more than one thing, send multiple pull requests.

  • Send coherent history. Make sure each individual commit in your pull request is meaningful. We try to follow the Conventional Commits specification.

Happy coding!

Useful commands

Notice that we use PNPM as our package manager.

Running dev app

pnpm dev

Building dev app for publish

pnpm demo:build

Previewing built dev app

pnpm demo:preview

Linting code

pnpm lint

Running E2E Tests

pnpm test:e2e

Running Unit Tests

pnpm test:unit

Building library for publish

pnpm lib:build