Skip to content

doc: adding "rules of thumb" #12744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
refack wants to merge 9 commits into from
+43 −0
Closed

doc: adding "rules of thumb" #12744

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9a79fe6
doc: add "rules of thumb" section
refack Apr 29, 2017
953c7e0
[squash] add two missing '.'s
refack Apr 29, 2017
9ab59c1
[squash] add some line breaks, and fix a few typos
refack Apr 29, 2017
1691471
[squash] trying to form full sentences, and adding a line in the "com…
refack Apr 29, 2017
edc0b43
[squash] more explicit working or style and linters
refack Apr 29, 2017
011263e
[squash] Collapse explanations
refack Apr 29, 2017
3a9ee5b
Removing personal pronouns
refack Apr 29, 2017
fccb06a
[squash] its -> it is
refack Apr 29, 2017
3fd0eb2
[squash] typos & remove "mark as blocked"
refack May 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[squash] more explicit working or style and linters
  • Loading branch information
@refack
refack committed Apr 29, 2017
commit edc0b43290c117f460f542130be61b08be3abeec
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,15 @@ This document will guide you through the contribution process.
pieces (still as self-contained as possible), and cross-reference them.
You can also mark some of them as `blocked` pending the others.
4. #### Be aware of our style rules
As part of acceptance of a PR the changes must pass our linters. For C++ we
use Google's `cpplint` (with some adjustments) so following their
[style-guide](https://github.com/google/styleguide) should keep you in line.
For JS we use this
As part of accepting a PR the changes __must__ pass our linters.
* For C++ we use Google's `cpplint` (with some adjustments) so following their
[style-guide](https://github.com/google/styleguide) should make your code
compliant with our linter.
* For JS we use this
[rule-set](https://github.com/nodejs/node/blob/master/.eslintrc.yaml)
for ESLint plus some of
[our own custom rules](https://github.com/nodejs/node/tree/master/tools/eslint-rules).
For markdown we have a
* For markdown we have a
[style guide](https://github.com/nodejs/node/blob/master/doc/STYLE_GUIDE.md).

### Step 1: Fork
Expand Down