Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 1.29 KB

Contributing to snoowrap

Reporting issues

tl;dr: Use GitHub issues, include relevant info

To report an issue with snoowrap, please create a new issue on GitHub. It's usually helpful to include any details that might be relevant to reproducing the issue (the code that causes it, the version of node that you're using, etc.)

Requesting features

To make a feature request, create a new issue on GitHub.

Making code contributions

tl;dr contributions are welcome, make sure the tests pass, keep the linter happy

Contributions are welcome. To contribute code, fork snoowrap and create a pull request.

Code style is enforced by ESLint -- please try to make it pass without any warnings/errors. The ESLint configuration can be found here, but it'll probably be easier to just copy the style of the surrounding code.

For bugfixes and new features, it's appreciated if you also add a regression test.

This guide contains details on how to run the tests, as well as a general overview of the code.