You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

26 lines
697 B

4 years ago
  1. # Contributing
  2. 1. Fork it
  3. 2. `npm install`
  4. 3. Create your feature branch (`git checkout -b my-new-feature`)
  5. 4. Commit your changes (`git commit -am 'Added some feature'`)
  6. 5. `npm test`
  7. 6. Push to the branch (`git push origin my-new-feature`)
  8. 7. Create new Pull Request
  9. ## Testing
  10. We use [lab](https://github.com/hapijs/lab) and [should](https://github.com/shouldjs/should.js) to write BDD test. Run our test suite with this command:
  11. ```
  12. npm test
  13. ```
  14. ## Code Style
  15. We use [standard](https://www.npmjs.com/package/standard) and [editorconfig](http://editorconfig.org) to maintain code style and best practices. Please make sure your PR adheres to the guides by running:
  16. ```
  17. npm run lint
  18. ```