Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

58 lines (44 loc) · 2.23 KB
Raw

Contributing to ironNode

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to uphold this code. [code-of-conduct]: http://todogroup.org/opencodeofconduct/#iron-node/opensource@github.com

The following is a set of guidelines for contributing to ironNode. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Submit an issue, feedback or a feature request - Any of these issue topics are welcome :O)

  • You can create an issue here, but before doing that please read the notes below and include as many details as possible with your report. If you can, please include:
    • The version of ironNode you are using
    • The operating system you are using
    • If applicable, what you were doing when the issue arose and what you expected to happen
  • Other things that will help resolve your issue:
    • Screenshots and animated GIFs
    • Error output that appears in your terminal, dev tools or as an alert
    • Perform a cursory search to see if a similar issue has already been submitted

Submitting Pull Requests

  • Fork it!
  • Clone your fork
  • Install development dependencies
    • cd iron-node;
    • npm install;
  • Create your feature branch: git checkout -b my-new-feature;
  • Add add your new code
  • Run the tests: npm test;
  • Commit your changes: git commit -am 'Add some feature';
  • Push to the branch: git push origin my-new-feature;
  • Submit a pull request 🐶

Execute iron-node in development mode

# mocha-test
$ node bin/run.js node_modules/mocha/bin/_mocha;

# run a custom script
$ node bin/run.js c:\\test\\yourscript.js;

# pipe something
$ echo var i = 0;debugger; | node bin/run.js c:\\test\\yourscript.js;