Contributing issues and pull requests is highly appreciated!
Please follow these guidelines:
Make sure that Node.js (at least version 14) is installed.
Install all development dependencies with npm install
.
Run tests:
npm run test
# or in watch mode
npm run test:watch
And type tests:
npm run type-test
Before you commit, run all following commands to ensure that all tests pass:
npm run test
npm run type-test
npm run lint
npm run build
When adding a new prop type, you need to modify several files:
src/prop-types/yourNewPropType.ts
(in camelCase please!) – the implementation.src/index.ts
– re-export the new prop type from the main entrypoint.tests/prop-types/yourNewPropType.spec.ts
– the unit tests.type-tests/prop-types/yourNewPropType.type.spec.ts
– the type tests.README.md
– the documentation.
Please use the existing files as a reference and follow the existing style.