crafatar/CONTRIBUTING.md
2015-02-03 23:09:20 +01:00

777 B

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: '"'
  1. Write only one expression per line
  • Bad: foo(); bar();
  1. Write valid JavaScript, a code linter is recommended!
  2. Explain code that is not obvious (comment above)
  3. If you add new functions, add documentation (comment above)
  • Wrap function arguments in + signs (e.g. the +type+ is used for…)
  1. If you add new functions, add tests (test/test.js)
  2. Run tests (npm test)
  3. Make sure as much of your code as possible is covered by tests
  4. Double check that your pull request is awesome :)