Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.36 KB

Contributing to regjsgen

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 regjsgen, commit your changes, & send a pull request.

Tests

Include updated unit tests in the tests directory as part of your pull request.

Before running the unit tests you’ll need to install, npm i, development dependencies. Run unit tests from the command-line via npm test. Fixtures can be updated from the regjsparser repository via npm run update-fixtures.

Coding Guidelines

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.

  • Quotes:
    Single-quoted strings are preferred to double-quoted strings; however, please use a double-quoted string if the value contains a single-quote character to avoid unnecessary escaping.

  • Comments:
    Please use single-line comments to annotate significant additions.