Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.51 KB

CONTIRBUTING.md

File metadata and controls

32 lines (20 loc) · 1.51 KB

Issues

Use (GitHub issues)[https://github.com/chandlerprall/insula/issues] to file and track bugs. Please ensure your bug description is clear and has sufficient instructions to be able to reproduce the issue.

The absolute best way to report a bug is to submit a pull request including a new failing test which describes the bug. When the bug is fixed, your pull request can then be merged!

The next best way to report a bug is to provide a reduced test case on jsFiddle or jsBin or produce exact code inline in the issue which will reproduce the bug.

Pull Requests

All active development of Insula happens on GitHub. We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. Install all dependencies. (npm install)
  3. If you've added code, add tests.
  4. Run tests and ensure your code passes lint. (npm run test)

Coding Style

  • 4 spaces for indentation (no tabs)
  • Prefer ' over "
  • Use semicolons;
  • Avd abbr wrds.
  • Use ES3 syntax except for import/export - there is no transpilation process other than Rollup to resolve imports

Why ES3 syntax?

It is difficult to guarantee the performance of code generated by Babel and other transpilers. As performance is a key tenant of Insula, and the community best-practice is to publish ES3 or ES5 code, we write ES3 to better control the code output.

License

By contributing to Insula you agree that your contributions will be licensed under its MIT license.