Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 1.2 KB

Contributing Guidelines

Things to know before contributing:

Tests

Unit tests should provide 100% coverage. Use:

npm run test
npm run test:unit:coverage

To run the tests and view the coverage report, to see which things are untested.

If some line of code really cannot be covered by a test or just doesn't make sense, see here how to ignore them.

Linting

This checks code quality with ESLint, formatting with Prettier and types with TypeScript. VSCode extensions for ESLint/Prettier are recommended, but you can always run:

npm run format

after doing your work, to fix most issues automatically.

Versioning

We use changesets for versioning. If you are contributing something that warrants a new release of this library, run npx changeset and follow the CLI prompts and add a human readable explanation of your change.

Contact

For new ideas, feature requests, issues, bugs, etc., use GitHub issues. Also, feel free to reach out to us on Slack.