Skip to content

Commit 7ffd299

Browse files
emilyavivaMyles Borins
authored and
Myles Borins
committed
doc: add final full stop in CONTRIBUTING.md
PR-URL: #3576 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
1 parent 166523d commit 7ffd299

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,21 @@ and built upon.
5151
The rules for the master branch are less strict; consult the
5252
[stability index](./doc/api/documentation.markdown#stability-index) for details.
5353

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
5555
always welcome but API or behavioral changes to modules at stability level 3
5656
(Locked) are off-limits.
5757

5858
#### Dependencies
5959

6060
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
6262
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.
6464

6565
In case of doubt, open an issue in the
6666
[issue tracker](https://github.com/nodejs/node/issues/) or contact one of the
6767
[project Collaborators](https://github.com/nodejs/node/#current-project-team-members).
68+
6869
Especially do so if you plan to work on something big. Nothing is more
6970
frustrating than seeing your hard work go to waste because your vision
7071
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"
8990
$ git config --global user.email "[email protected]"
9091
```
9192

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:
9495

9596
1. The first line should be 50 characters or less and contain a short
9697
description of the change prefixed with the name of the changed
@@ -132,15 +133,15 @@ $ git rebase upstream/master
132133

133134
### Step 5: Test
134135

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
137138
structured (license boilerplate, common includes, etc.).
138139

139140
```text
140141
$ ./configure && make -j8 test
141142
```
142143

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
144145
patches that fail either check.
145146

146147
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
168169
Go to https://github.com/yourusername/node and select your feature branch.
169170
Click the 'Pull Request' button and fill out the form.
170171

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
172173
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
174175
not send out notifications when you add commits.
175176

176177

0 commit comments

Comments
 (0)