Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 842 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 842 Bytes
  1. Open an issue to discuss the feature you want to implement or need. This will help us to figure out how to fit it in and will avoid unnecessary work on your part.
  2. Implement whatever you want and write tests
  3. Make sure npm test passes. This will run your tests and lint the code.
  4. Once you are happy with the code, add yourself to the project contributors (./CONTRIBUTORS.md).
  5. Create a PR against the master branch

Development

npm run init
npm start
open http://localhost:8080

Now edit ./docs.

There's also a TDD mode for testing. Run it through npm run test:watch and develop while it's running.

You can run individual tests by passing a pattern like this: npm test -- does not crash with a number. This works also with npm run test:watch.