CONTRIBUTING.md

   1 # Contributing to Node.js
   2
   3 ## Code of Conduct
   4
   5 The Code of Conduct explains the *bare minimum* behavior
   6 expectations the Node Foundation requires of its contributors.
   7 [Please read it before participating.](./CODE_OF_CONDUCT.md)
   8
   9 ## Issue Contributions
  10
  11 When opening new issues or commenting on existing issues on this repository
  12 please make sure discussions are related to concrete technical issues with the
  13 Node.js software.
  14
  15 For general help using Node.js, please file an issue at the
  16 [Node.js help repository](https://github.com/nodejs/help/issues).
  17
  18 Discussion of non-technical topics including subjects like intellectual
  19 property, trademark and high level project questions should move to the
  20 [Technical Steering Committee (TSC)](https://github.com/nodejs/TSC/issues)
  21 instead.
  22
  23 ## Code Contributions
  24
  25 The Node.js project has an open governance model and welcomes new contributors.
  26 Individuals making significant and valuable contributions are made
  27 _Collaborators_ and given commit-access to the project. See the
  28 [GOVERNANCE.md](./GOVERNANCE.md) document for more information about how this
  29 works.
  30
  31 This document will guide you through the contribution process.
  32
  33 ### Step 1: Fork
  34
  35 Fork the project [on GitHub](https://github.com/nodejs/node) and check out your
  36 copy locally.
  37
  38 ```text
  39 $ git clone git@github.com:username/node.git
  40 $ cd node
  41 $ git remote add upstream git://github.com/nodejs/node.git
  42 ```
  43
  44 #### Which branch?
  45
  46 For developing new features and bug fixes, the `master` branch should be pulled
  47 and built upon.
  48
  49 #### Respect the stability index
  50
  51 The rules for the master branch are less strict; consult the
  52 [stability index](./doc/api/documentation.markdown#stability-index) for details.
  53
  54 In a nutshell, modules are at varying levels of API stability. Bug fixes are
  55 always welcome but API or behavioral changes to modules at stability level 3
  56 (Locked) are off-limits.
  57
  58 #### Dependencies
  59
  60 Node.js has several bundled dependencies in the *deps/* and the *tools/*
  61 directories that are not part of the project proper. Any changes to files
  62 in those directories or its subdirectories should be sent to their respective
  63 projects. Do not send your patch to us, we cannot accept it.
  64
  65 In case of doubt, open an issue in the
  66 [issue tracker](https://github.com/nodejs/node/issues/) or contact one of the
  67 [project Collaborators](https://github.com/nodejs/node/#current-project-team-members).
  68
  69 Especially do so if you plan to work on something big. Nothing is more
  70 frustrating than seeing your hard work go to waste because your vision
  71 does not align with the project team. Node.js has two IRC channels,
  72 [#Node.js](http://webchat.freenode.net/?channels=node.js) for general help and questions, and
  73 [#Node-dev](http://webchat.freenode.net/?channels=node-dev) for development of node core specifically.
  74
  75
  76 ### Step 2: Branch
  77
  78 Create a feature branch and start hacking:
  79
  80 ```text
  81 $ git checkout -b my-feature-branch -t origin/master
  82 ```
  83
  84 ### Step 3: Commit
  85
  86 Make sure git knows your name and email address:
  87
  88 ```text
  89 $ git config --global user.name "J. Random User"
  90 $ git config --global user.email "j.random.user@example.com"
  91 ```
  92
  93 Writing good commit logs is important. A commit log should describe what
  94 changed and why. Follow these guidelines when writing one:
  95
  96 1. The first line should be 50 characters or less and contain a short
  97    description of the change prefixed with the name of the changed
  98    subsystem (e.g. "net: add localAddress and localPort to Socket").
  99 2. Keep the second line blank.
 100 3. Wrap all other lines at 72 columns.
 101
 102 A good commit log can look something like this:
 103
 104 ```
 105 subsystem: explaining the commit in one line
 106
 107 Body of commit message is a few lines of text, explaining things
 108 in more detail, possibly giving some background about the issue
 109 being fixed, etc. etc.
 110
 111 The body of the commit message can be several paragraphs, and
 112 please do proper word-wrap and keep columns shorter than about
 113 72 characters or so. That way `git log` will show things
 114 nicely even when it is indented.
 115 ```
 116
 117 The header line should be meaningful; it is what other people see when they
 118 run `git shortlog` or `git log --oneline`.
 119
 120 Check the output of `git log --oneline files_that_you_changed` to find out
 121 what subsystem (or subsystems) your changes touch.
 122
 123
 124 ### Step 4: Rebase
 125
 126 Use `git rebase` (not `git merge`) to sync your work from time to time.
 127
 128 ```text
 129 $ git fetch upstream
 130 $ git rebase upstream/master
 131 ```
 132
 133
 134 ### Step 5: Test
 135
 136 Bug fixes and features **should come with tests**. Add your tests in the
 137 test/parallel/ directory. Look at other tests to see how they should be
 138 structured (license boilerplate, common includes, etc.).
 139
 140 ```text
 141 $ ./configure && make -j8 test
 142 ```
 143
 144 Make sure the linter is happy and that all tests pass. Please, do not submit
 145 patches that fail either check.
 146
 147 If you are updating tests and just want to run a single test to check it, you
 148 can use this syntax to run it exactly as the test harness would:
 149
 150 ```text
 151 $ python tools/test.py -v --mode=release parallel/test-stream2-transform
 152 ```
 153
 154 You can run tests directly with node:
 155
 156 ```text
 157 $ ./node ./test/parallel/test-stream2-transform.js
 158 ```
 159
 160 Remember to recompile with `make -j8` in between test runs if you change
 161 core modules.
 162
 163 ### Step 6: Push
 164
 165 ```text
 166 $ git push origin my-feature-branch
 167 ```
 168
 169 Go to https://github.com/yourusername/node and select your feature branch.
 170 Click the 'Pull Request' button and fill out the form.
 171
 172 Pull requests are usually reviewed within a few days. If there are comments
 173 to address, apply your changes in a separate commit and push that to your
 174 feature branch. Post a comment in the pull request afterwards; GitHub does
 175 not send out notifications when you add commits.
 176
 177 ## Developer's Certificate of Origin 1.1
 178
 179 By making a contribution to this project, I certify that:
 180
 181 * (a) The contribution was created in whole or in part by me and I
 182   have the right to submit it under the open source license
 183   indicated in the file; or
 184
 185 * (b) The contribution is based upon previous work that, to the best
 186   of my knowledge, is covered under an appropriate open source
 187   license and I have the right under that license to submit that
 188   work with modifications, whether created in whole or in part
 189   by me, under the same open source license (unless I am
 190   permitted to submit under a different license), as indicated
 191   in the file; or
 192
 193 * (c) The contribution was provided directly to me by some other
 194   person who certified (a), (b) or (c) and I have not modified
 195   it.
 196
 197 * (d) I understand and agree that this project and the contribution
 198   are public and that a record of the contribution (including all
 199   personal information I submit with it, including my sign-off) is
 200   maintained indefinitely and may be redistributed consistent with
 201   this project or the open source license(s) involved.