UNPKG

log-ocd

Version:
30 lines (22 loc) 1.08 kB
# Contributing Guide ### Show Some Logging Love All OCD contributions for _[log-ocd](https://github.com/imaginate/log-ocd)_ are appreciated! Please follow the below directions. ## Directions - Fork and clone this repository - Create a new branch for your additions - Add your contributions - Add tests for your contributions - Run ```$ npm test ``` - Debug your additions - Submit a pull request ## Pointers - Ensure all additions are [ES5 compliant](http://www.ecma-international.org/publications/files/ECMA-ST-ARCH/ECMA-262%205th%20edition%20December%202009.pdf) - Follow the coding conventions you see in the existing code - Know and use [JSDoc3](http://usejsdoc.org/) with [Closure Compiler specific syntax](https://developers.google.com/closure/compiler/docs/js-for-compiler) - Include unit tests for all new functionality - Ensure all unit tests are passing before submitting a pull request ## Contact - **bugs and improvements:** [open an issue](https://github.com/imaginate/log-ocd/issues) - **all other questions:** imagineadamsmith@gmail.com ---- **Live OCD**