crafatar/CONTRIBUTING.md

Contribution guidelines

For Issues:

1. Check for similar issues first!
2. Provide as many details as possible

For Pull Requests:

1. Indent using 2 spaces
2. Use double quotes for strings
   • Exception: '"'
3. Write only one expression per line
   • Bad: foo(); bar();
4. Write valid JavaScript, a code linter is recommended!
5. Explain code that is not obvious (comment above)
6. If you add new functions, add documentation (comment above)
   • Wrap function arguments in + signs (e.g. the +type+ is used for…)
7. If you add new functions, add tests (test/test.js)
8. If you fixed an issue, add a test that would catch this issue
9. Run tests (npm test)
10. Make sure as much of your code as possible is covered by tests
11. Double check that your pull request is awesome :)