@@ -51,20 +51,21 @@ and built upon.
51
51
The rules for the master branch are less strict; consult the
52
52
[ stability index] ( ./doc/api/documentation.markdown#stability-index ) for details.
53
53
54
- In a nutshell, modules are at varying levels of API stability. Bug fixes are
54
+ In a nutshell, modules are at varying levels of API stability. Bug fixes are
55
55
always welcome but API or behavioral changes to modules at stability level 3
56
56
(Locked) are off-limits.
57
57
58
58
#### Dependencies
59
59
60
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
61
+ directories that are not part of the project proper. Any changes to files
62
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.
63
+ projects. Do not send your patch to us, we cannot accept it.
64
64
65
65
In case of doubt, open an issue in the
66
66
[ issue tracker] ( https://github.com/nodejs/node/issues/ ) or contact one of the
67
67
[ project Collaborators] ( https://github.com/nodejs/node/#current-project-team-members ) .
68
+
68
69
Especially do so if you plan to work on something big. Nothing is more
69
70
frustrating than seeing your hard work go to waste because your vision
70
71
does not align with the project team. Node.js has two IRC channels,
@@ -89,8 +90,8 @@ $ git config --global user.name "J. Random User"
89
90
$ git config --global user.email "[email protected] "
90
91
```
91
92
92
- Writing good commit logs is important. A commit log should describe what
93
- changed and why. Follow these guidelines when writing one:
93
+ Writing good commit logs is important. A commit log should describe what
94
+ changed and why. Follow these guidelines when writing one:
94
95
95
96
1 . The first line should be 50 characters or less and contain a short
96
97
description of the change prefixed with the name of the changed
@@ -132,15 +133,15 @@ $ git rebase upstream/master
132
133
133
134
### Step 5: Test
134
135
135
- Bug fixes and features ** should come with tests** . Add your tests in the
136
- test/parallel/ directory. Look at other tests to see how they should be
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
137
138
structured (license boilerplate, common includes, etc.).
138
139
139
140
``` text
140
141
$ ./configure && make -j8 test
141
142
```
142
143
143
- Make sure the linter is happy and that all tests pass. Please, do not submit
144
+ Make sure the linter is happy and that all tests pass. Please, do not submit
144
145
patches that fail either check.
145
146
146
147
If you are updating tests and just want to run a single test to check it, you
@@ -168,9 +169,9 @@ $ git push origin my-feature-branch
168
169
Go to https://github.com/yourusername/node and select your feature branch.
169
170
Click the 'Pull Request' button and fill out the form.
170
171
171
- Pull requests are usually reviewed within a few days. If there are comments
172
+ Pull requests are usually reviewed within a few days. If there are comments
172
173
to address, apply your changes in a separate commit and push that to your
173
- feature branch. Post a comment in the pull request afterwards; GitHub does
174
+ feature branch. Post a comment in the pull request afterwards; GitHub does
174
175
not send out notifications when you add commits.
175
176
176
177
0 commit comments