Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.33 KB

Contributing

Pull Requests are welcome for any issues, if you have any questions please raise an issue.

If you discover a security issue please create an issue stating you've discovered a security issue but don't divulge the issue, one of the maintainers will respond with an email address you can send the details to. Once the issue has been patched the details can be made public.

If you wish to join the team please raise an issue and one of the maintainers will assess your request.

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases with complete code coverage. Patches that increase test coverage are happily accepted.

Ensure that the test suite passes by executing:

$ npm test

Ensure that lint passes

$ npm run lint

Some lint errors can be fixed with

npm run lintfix

Coverage reports can be generated and viewed by executing:

npm run coverage

The output in html form will be in var/coverage

Templates such as README.md can be updated via

npm run templates

If you are starting a new project run

npm run init-new-project

WARNING This will overwrite files which are listed in the ignoreExisting array of templates/variables.js