Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.4 KB

CONTRIBUTING.markdown

File metadata and controls

42 lines (26 loc) · 1.4 KB

Contribute to node-proto2json

It is simple to contribute: fork this repository, write some code and tests, ensure that tests passes, lint code and then send a pull request to me on Github. I'll be glad to see your forks and commits in them :) Thanks!

Run tests

All functions and possible use cases should have tests, placed in tests sub-folder. node-proto2json uses mocha as testing tool. If you contributing something, you should check that your changes do not breakes tests.

If you change some code you should regenerate parser from source:

$> make parser

and run tests after that:

$> make test

You can go to Travis CI site to view current tests results.

Coding style

Code style based on Node.js code styles.

  1. Discuss large changes before coding (this is good idea in collaborative development)
  2. Javascript code should follow Douglas Crockford code conventions for the javascript programming language and be run through Nodelint. And:
    • Code should has two space indention
    • Multi-line if statements must have braces
  3. All code must be MIT licensed

You can lint node-proto2json code by executing:

$> make lint