We welcome all contributions!
Before creating a PR, please raise an issue to discuss it.
We use convention commits style of commit messages.
The codebase is written in typescript, this is set to be strict with all warnings and errors turned on. We also use ts-lint with pretty much all rules turned on. Both are run as part of the build.
You can run npm run lint to show any style issues separate from the build.
- Use Promises instead callbacks
- Files should be 100 lines or less
- Everything is testable
Tests are using jest, please see existing tests for recommended formatting.