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 make 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

WARNING

Development environment requires Docker and Docker compose.

Starting containers

make up

Packaging lib

make package

Generate lib API reference

make typedoc

Starting docs website

make dev

INFO

Docs website is available on vphoneinput.localhost.

Linting code

pnpm lint

Running unit tests

make test-unit

Running E2E tests

make test-e2e