- Install/update the dependencies.
npm install
- Make sure the code lints.
npm run lint
- Make sure all of the tests pass.
npm test
- New code must have new unit tests.
- New features/metrics or changes to existing features/metrics must be documented in the readme file.
- Adhere to the coding conventions that are used elsewhere in the codebase.
- Add yourself to the authors file.
- Feel free to open an issue first, if the change is one that you think needs some discussion. Please check the issue list first to avoid opening duplicate issues.
- Issues marked with the "beginners only" label are reserved for first-time contributors only.