Thank you for your willingness to contribute to this project! We greatly appreciate your efforts. Please note our brief code of conduct before proceeding.
When creating a new Issue...
- check to see if your Issue has already been raised
- use an appropriate Issue template when available
- select appropriate tags
- never disclose security vulnerabilities in an Issue; refer to this project's security policy
Always be clear when describing the changes you commit to the project. Shorter commit messages are fine for minor changes, but anything major should include more information:
$ git commit -m "a summary of your changes
>
> Additional text describing what was changed and why."This project adheres to a set of coding conventions which include the following:
- indentation uses four spaces instead of tabs
- semicolons are required at the end of each statement
- single quotes are required for strings, excluding template strings that use interpolation
- spaces are required after key words, array elements, and operators
- blocks belong on the same line as the reserved word that precedes them
- files end in a line feed character
- and more!
Enabling EditorConfig in your IDE will help enforce the basics in your editor, but it won't catch everything. For that, this project uses ESLint to enforce consistent coding conventions between contributors.
When creating a new Pull Request...
- use an appropriate Pull Request template when available
- if applicable, reference any Issue(s) related to your Pull Request
- check your code against ESLint by running the
npm run eslintscript - provide tests for any code you contribute
- note that all Pull requests will be reviewed and discussed before they are merged
At the moment, none of the code in this project is licensed.