Things to know before contributing:
Unit tests should provide 100% coverage. Use:
npm run test
npm run test:unit:coverageTo 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.
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 formatafter doing your work, to fix most issues automatically.
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.
For new ideas, feature requests, issues, bugs, etc., use GitHub issues. Also, feel free to reach out to us on Slack.