Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
15 lines (13 loc) · 675 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (13 loc) · 675 Bytes
Raw

Contributing ❤️

Thanks for your interest! In order to keep the code coherent there are some easy-to-follow rules.

  • Use JSHint and respect the .jshintrc file.
  • Use EditorConfig and respect the .editorconfig file.
  • Use npm run doc to generate an annotated code source with docco and start using it!
  • Write test for your modifications (use mocha and chai modules).
  • Keep the code coverage as high as possible (100% is awesome!). Install istanbul module and run npm run coverage to check it.
  • Proudly add yourself to the contributors in package.json! 👍