Skip to content
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

doc: adding "rules of thumb" #12744

Closed
wants to merge 9 commits into from
Closed

doc: adding "rules of thumb" #12744

Changes from 6 commits
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
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,48 @@ works.

This document will guide you through the contribution process.

### Rules of thumb

<details>
<summary><strong>Provide motivation for the change</strong></summary>
Try to explain why this change will make the code better. For example, does
it fix a bug, or is it a new feature, etc. This should expressed in the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing "be" in "This should be expressed".

commit messages as well as in the PR description.
</details>
<details>
<summary><strong>Don't make <em>unnecessary</em> code changes</strong></summary>
<em>Unnecessary</em> code changes are changes made because of personal preference
or style. For example, renaming of variables or functions, adding or removing
white spaces, and reordering lines or whole code blocks. These sort of
changes should have a good reason since otherwise they cause unnecessary
<a href="https://blog.gitprime.com/why-code-churn-matters">"code churn"</a>.
As part of the project's strategy we maintain multiple release lines, code
churn might hinder back-porting changes to other lines. Also when you
change a line, your name will come up in `git blame` and shadow the name of
the previous author of that line.
</details>
<details>
<summary><strong>Keep your change-set self contained but at a reasonable size</strong></summary>
Use your good judgment when making a big change. If you can't think of a
good reason but need to make a very big PR, try to break it into smaller
pieces (still as self-contained as possible), and cross-reference them.
You can also mark some of them as `blocked` pending the others.
</details>
<details>
<summary><strong>Be aware of our style rules</strong></summary>
As part of accepting a PR the changes <strong>must</strong> pass our linters.
<ul>
<li>For C++ we use Google's `cpplint` (with some adjustments) so following their
<a href="https://github.com/google/styleguide">style-guide</a> should make your code
compliant with our linter.</li>
<li>For JS we use this
<a hreaf="https://github.com/nodejs/node/blob/master/.eslintrc.yaml">rule-set</a>
for ESLint plus some of
<a href="https://github.com/nodejs/node/tree/master/tools/eslint-rules">our own custom rules</a>.</li>
<li>For markdown we have a <a href="https://github.com/nodejs/node/blob/master/doc/STYLE_GUIDE.md">style guide</a></li>
</ul>
</details>

### Step 1: Fork

Fork the project [on GitHub](https://github.com/nodejs/node) and check out your
Expand Down Expand Up @@ -122,6 +164,7 @@ changed and why. Follow these guidelines when writing one:
Refs: http://eslint.org/docs/rules/space-in-parens.html
Refs: https://github.com/nodejs/node/pull/3615
```
- It's it's not a fix, you should document the motivation for the change
Copy link
Member

@Trott Trott Apr 29, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's it's -> If it's

Punctuation at the end of the change.

Avoid you.

So something like this perhaps:

If it's not a fix, document the motivation for the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed and removed you, but there are a ton of previously existing your in there.


A good commit log can look something like this:

Expand Down