While we love contributions, we also need to ensure that our library is of great quality. Thus we require you to follow some simple guidelines when you're submitting your contributions.
Before opening an issue, please search the issue tracker to make sure your issue hasn’t already been reported.
Visit the issue tracker to find a list of open issues that need attention.
Fork, then clone the repo:
git clone https://github.com/oesukam/drc-data.git
Branches created should be named using the following format:
{type}-{2-3 word summary separated with hyphen}
Type:
- feat: For new features
- bug: Fixing bugs
- chore: Refactoring, improving the code or the documentation
Example:
chore-improve-readme
To run tests:
npm run test // Will run tests once
To continuously watch and run tests, run the following:
npm run test:watch
To Lint
npm run lint
The build command should handle it but always run the lint command to ensure we are all developing with the same code standards.
For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don’t want you to waste your efforts on a pull request that we won’t want to accept.
On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgement!
- Open a new issue in the Issue tracker
- Fork the repo
- Create a new feature branch based off the
masterbranch - Create breaking test(s) before implementing any fixes or functionality
- Make your changes
- Submit a pull request, referencing any issue that it resolves
Code of Conduct is adapted from Contributor Covenant, version 2.0
Thank you, we 💜 your contributions!