| 1 | # Welcome!
|
| 2 | :heart: Thanks for your interest and time in contributing to this project.
|
| 3 |
|
| 4 | ## What We Use
|
| 5 |
|
| 6 | - Linting: [ESLint](http://eslint.org/)
|
| 7 | - NPM: [NPM as a Build Tool](https://css-tricks.com/using-npm-build-tool/)
|
| 8 |
|
| 9 | ## Pull Requests
|
| 10 |
|
| 11 | Please lint your changes before submitting a Pull Request. You can lint your
|
| 12 | changes by running:
|
| 13 |
|
| 14 | ```console
|
| 15 | $ npm run lint
|
| 16 | ```
|
| 17 |
|
| 18 | Please avoid committing `package-lock.json` files.
|
| 19 |
|
| 20 | Please don't change variable or parameter names to match your
|
| 21 | personal preferences, unless the change is part of a refactor
|
| 22 | or significant modification of the codebase (which is very rare).
|
| 23 |
|
| 24 | Please remember to thoroughly explain your Pull Request if it
|
| 25 | doesn't have an associated issue. If you're changing code
|
| 26 | significantly, please remember to add inline or block comments
|
| 27 | in the code as appropriate.
|
| 28 |
|
| 29 | ## Thanks
|
| 30 |
|
| 31 | For your interest, time, understanding, and for following this simple guide.
|