Contributing

Getting your code into Node

The only “official” node repository is https://github.com/joyent/node. For code, docs, tests, or anything else, joyent/node is the repository that reflects the official state of the Node.js project. That’s where all patches have to end up if they are going to be in the release, website, or API docs. There are a variety of ways to do this.

1. Email patches to [email protected] and post them to the node.js development mailing list. Please add “[PATCH]” in the subject
2. Send a pull request via github to joyent/node
3. Post an issue to the mailing list describing the problem and paste a url to the patch gist

Some participation guidelines

1. Discuss large changes on mailing list before coding
2. Javascript code style should follow Google’s JavaScript style guide and be run through the linter. `make jslint` to validate.
3. C++ code should follow Google’s C++ style guide and be run through cpplint with `make cpplint`.
4. Agree to the contributor agreement

Git commits/patches

1. the first line should be maximum 50 columns
2. the second line should blank
3. any additional lines should not exceed 80 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. make your change. Remember to update tests and docs as well as code!
3. commit your change
4. Use the git format-patch command to generate patch files.