blob: 1ce06ca0e383dac6f79a305097b7c7735a67b711 [file] [log] [blame] [view]
# DCO
To contribute to this project you must accept our [developer certificate of origin](https://github.com/dscape/nano/blob/master/README.md)
# Contributing
Everyone is welcome to contribute with patches, bug-fixes and new features
1. Create an [issue][2] on github so the community can comment on your idea
2. Fork `nano` in github
3. Create a new branch `git checkout -b my_branch`
4. Create tests for the changes you made
5. Make sure you pass both existing and newly inserted tests
6. Commit your changes
7. Push to your branch `git push origin my_branch`
8. Create a pull request
to run tests make sure you npm test but also run tests without mocks:
``` sh
npm run unmocked
npm run mocked
npm test
```
Please fix all issues identified in the pre-commit hooks before sending your patch. if you don't, we will close the patch and ask you to re-open it once you have:
1. 100% code coverage
2. proper codestyle
3. linted all your code
This is not a replacement for appropriate tests, please make sure that you have adequate coverage and thoroughly test the code you introduced.
You can add verbose debug messages while running tests by doing:
```
DEBUG=* node your_nano_scripts.js
```
You can turn nocks on and off using the `NOCK_OFF` environment variable.
[2]: http://github.com/dscape/nano/issues