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.

31 lines
1.2 KiB

4 years ago
  1. # Contributing Guidelines
  2. Contributions are always welcome!
  3. **Before spending lots of time on something, ask for feedback on your idea first!**
  4. Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.
  5. ## Installing
  6. Fork and clone the repo, then `npm install` to install all dependencies and `npm test` to ensure all is okey before you start anything.
  7. ## Testing
  8. Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem).
  9. ## Code Style
  10. [![standard][standard-image]][standard-url]
  11. This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. You are encouraged to install it globally. `npm test` runs `standard` so you don't have to!
  12. ```
  13. npm i standard -g
  14. ```
  15. It is intentional to don't have `standard`, `istanbul` and `coveralls` in the devDependencies. Travis will handle all that stuffs. That approach will save bandwidth also installing and development time.
  16. [standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
  17. [standard-url]: https://github.com/feross/standard