We welcome code contributions!
Any contribution is very welcome — code, documentation, applications, tutorials! These guidelines were put together to help you make contributions.
We can only fix issues we know about. Thus, feel free to report liberally; please make an effort to report issues to the right repository.
We follow the JavaScript conventions as described by the
Google JS Style. Code should pass
ESLint and tests before committing, so that we have the
master branch clean. In the top level shell directory, you can run npm test — this will run both the linter and tests. To run only the linter npm run l. Generally, you can always use a pre-commit hook.
Keep the first line of the commit message under 72 characters — it's a
summary. Also, write everything in the imperative: "Fix bug" and not "Fixed
bug" or "Fixes bug." Also, link it to the issue you're working on (see
below), by adding the issue ID prefixed by the # character
at the end of your message (e.g., #123).
For a 2-minute guide on commit messages, read Tim Pope's guidelines.
Make sure you leave a reply to the issue on you are starting to work on stating that you're looking into it so that other people do not duplicate your effort — and feel free to ask for help on the the mailing list!
teesnsy: Issues marked as "teensy" are a great place to start.