-
Notifications
You must be signed in to change notification settings - Fork 76
Contributing Handbook
So you want to contribute to the project? How lovely! Here are a few things to keep in mind when working with the project:
ESlint is used for style management. Make sure that your IDE recognizes the project's eslint config before you start developing.
This project is using jest for testing and the test specifications should be placed within the /test folder. All functionality should have it's use-cases somewhat thoroughly tested (best sentence ever, thank you very much).
You test the project by running npm run test. It is worth noting that ESLint will run prior to Jest to make sure that there are no linting errors in the code.
"branches": 50,
"functions": 50,
"lines": 50,
"statements": 50
When you are done with your contribution, issue a pull request. There is a TravisCI setup that will run checks on each commit to make sure that the tests are looking fab, so please make sure to check that the checks are passing.
The project maintainers will then have a look at your awesome contribution as soon as possible!
🎺 This is the most important thing of all.