Contributions are always welcome. Before contributing, please search the issue tracker; your issue may have already been discussed or fixed in master. To contribute, fork the repository, commit your changes, and send a pull request.
Feature requests should be submitted in the issue tracker, with a description of the expected behavior & use case. Before submitting a request, please search for similar ones in the closed issues.
For additions or bug fixes you should only need to modify index.js. Include updated unit tests in the test directory as part of your pull request. Don’t worry about regenerating the site/ files.
Before running the unit tests you’ll need to install, npm i, development dependencies. Run unit tests from the command-line via npm test.
In addition to the following guidelines, please follow the conventions already established in the code.
-
Spacing:
Use two spaces for indentation. No tabs. -
Naming:
Keep variable & method names concise & descriptive.
Variable namesindex,array, &iterateeare preferable toi,arr, &fn. -
Comments:
Please use single-line comments to annotate significant additions, & JSDoc-style comments for functions.
Guidelines are enforced using ESLint:
$ npm run style