Contributing to Catharsis
Thanks for your interest in contributing to Catharsis! Please follow these simple guidelines to make the process easier for everyone.
- Code Style: Follow the predominant code style in the file you're editing.
Unit Tests: Write some! It's especially critical to write unit tests if you're changing the PEG.js grammar or fixing a bug. Your code must also pass all existing unit tests (or, if your code changes Catharsis' behavior, you must update the tests to reflect the new behavior).
- JSHint Clean: Make sure your code, including unit tests, passes the
JSHint checks in the project's
.jshintrcfile. PEG.js-generated code is exempt.
- Generated Code: Don't forget to regenerate the parser code after you edit the PEG.js grammar.
npm run-script prepublishto regenerate the code.