Want to contribute, but not sure where to start? Check out our issue board!
This document outlines general patterns and conventions for contributing to the project. For in-depth documentation on ORC, read the documentation.
By submitting pull requests, you agree that your work may be licensed under the GNU Affero General Public License Version 3 (or later).
When submitting an issue, please take care to follow the
ISSUE_TEMPLATE.md and include as much information as possible. Bonus points
for a corresponding pull request that fixes the issue.
ORC adheres to Felix's Node.js Style Guide. Please take the time to review the style guide and take care to follow it.
bin/- Command line programs and utilitiesdoc/- Markdown documentation on various topics not covered by JSDoclib/- All core classes and modulestest/- Unit and integration tests for core classes and modules
You should also make the best use of JSDoc comments as shown throughout the source code. These annotation are used to generate the library's documentation website. Please be as descriptive as possible and take care to familiarize yourself with all of the possible JSDoc tags for being as thorough as possible.
Pull requests submitted without additional test coverage are unlikely to be merged. Pull requests that decrease test coverage will be rejected. If your submission fixes a bug that was not previously caught with the test suite, then please add an additional test that does cover it.
You can run the coverage report with:
npm run coverage
To help maintain consistent expectations for code quality and enforcing these
conventions, there is an included .eslintrc file. Most editors support using
this to alert you of offending code in real time but, if your editor does not,
you can run the linter with:
npm run linter
Alternatively, the linter will run as part of the test suite as well, which can be executed with:
npm test
Before sending your PR, go ahead and add yourself to the contributors array
in the package.json file - you earned it 👍.
Have fun and be excellent!