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.
27 lines
697 B
27 lines
697 B
4 years ago
|
# Contributing
|
||
|
|
|
||
|
|
1. Fork it
|
||
|
|
2. `npm install`
|
||
|
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||
|
|
4. Commit your changes (`git commit -am 'Added some feature'`)
|
||
|
|
5. `npm test`
|
||
|
|
6. Push to the branch (`git push origin my-new-feature`)
|
||
|
|
7. Create new Pull Request
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm test
|
||
|
|
```
|
||
|
|
|
||
|
|
## Code Style
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm run lint
|
||
|
|
```
|
||
|
|
|