Contributing

Getting your code into Node Inspector

The only "official" Node Inspector repository is https://github.com/node-inspector/node-inspector. For code, docs, tests, or anything else, node-inspector/node-inspector is the repository where all patches have to end up if they are going to be in the release. To submit a patch fork the repository and send a pull request via github to node-inspector/node-inspector.

Some participation guidelines

• Miguel de Icaza has a good post on Open Source Contribution Etiquette that is worth reading, as the guidance he gives applies well to Node Inspector.
• Create a github issue for large changes and discuss the change there before coding
• Javascript code style should follow Google's JavaScript style guide and be run through the linter. npm run lint to validate, you need to have GJsLint installed.

Testing

Node Inspector comes with an automated test suite run via "npm test". The tests are written in BDD style using mocha and chai.

Git commits/patches

1. the first line should be maximum 50 columns
2. the second line should be blank
3. any additional lines should not exceed 72 columns.
4. should have the author field properly filled out with your full name and email address.

To generate patch files:

1. Clone the git repository.
2. Create a branch for you change/feature off of the master branch.
3. Make your change. Remember to update tests as well as code!
4. Commit your change and push it to github.
5. Use github's pull requests to submit the patch.