When opening new issues or commenting on existing issues on this repository please make sure discussions are related to concrete technical issues with the io.js software.
Discussion of non-technical topics including subjects like intellectual property, trademark and high level project questions should move to the node-forward discussions repository instead.
The io.js project has an open governance model and welcomes new contributors. Individuals making significant and valuable contributions are made Collaborators and given commit-access to the project. See the GOVERNANCE.md document for more information about how this works.
This document will guide you through the contribution process.
Fork the project on GitHub and check out your copy locally.
$ git clone git@github.com:username/io.js.git $ cd io.js $ git remote add upstream git://github.com/nodejs/io.js.git
For developing new features and bug fixes, the master
branch should be pulled and built upon.
The rules for the master branch are less strict; consult the stability index for details.
In a nutshell, modules are at varying levels of API stability. Bug fixes are always welcome but API or behavioral changes to modules at stability level 3 (Locked) are off-limits.
io.js has several bundled dependencies in the deps/ and the tools/ directories that are not part of the project proper. Any changes to files in those directories or its subdirectories should be sent to their respective projects. Do not send your patch to us, we cannot accept it.
In case of doubt, open an issue in the issue tracker or contact one of the project Collaborators. (IRC is often the best medium.) Especially do so if you plan to work on something big. Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with the project team.
Create a feature branch and start hacking:
$ git checkout -b my-feature-branch -t origin/master
Make sure git knows your name and email address:
$ git config --global user.name "J. Random User" $ git config --global user.email "j.random.user@example.com"
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:
A good commit log can look something like this:
subsystem: explaining the commit in one line Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue being fixed, etc. etc. The body of the commit message can be several paragraphs, and please do proper word-wrap and keep columns shorter than about 72 characters or so. That way `git log` will show things nicely even when it is indented.
The header line should be meaningful; it is what other people see when they run git shortlog
or git log --oneline
.
Check the output of git log --oneline files_that_you_changed
to find out what subsystem (or subsystems) your changes touch.
Use git rebase
(not git merge
) to sync your work from time to time.
$ git fetch upstream $ git rebase upstream/master
Bug fixes and features should come with tests. Add your tests in the test/parallel/ directory. Look at other tests to see how they should be structured (license boilerplate, common includes, etc.).
$ make jslint test
Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check.
If you are updating tests and just want to run a single test to check it, you can use this syntax to run it exactly as the test harness would:
$ python tools/test.py -v --mode=release parallel/test-stream2-transform
You can run tests directly with iojs:
$ iojs ./test/parallel/test-streams2-transform.js
$ git push origin my-feature-branch
Go to https://github.com/yourusername/io.js and select your feature branch. Click the ‘Pull Request’ button and fill out the form.
Pull requests are usually reviewed within a few days. If there are comments to address, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits.
By making a contribution to this project, I certify that:
This Code of Conduct is adapted from Rust's wonderful CoC.