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
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
Removing personal pronouns
  • Loading branch information
@refack
refack authored Apr 29, 2017
commit 3a9ee5bba5fe87f4b00e07a40aba766b73a0af6d
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ 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.
<summary><strong>Keep the change-set self contained but at a reasonable size</strong></summary>
Use good judgment when making a big change. If a reason doesn't come to mid
but a very big chage needs to be made, try to break it into smaller
pieces (still as self-contained as possible), and cross-reference them, and
marking some of them as `blocked` pending the others.
Copy link
Copy Markdown
Member

@lpinca lpinca May 2, 2017

Choose a reason for hiding this comment

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

I think that asking this to a first time contributor is a bit too much. In the unlikely case where they will propose a big change we can still ask them to apply the necessary tweaks.

Copy link
Copy Markdown
Member

@Trott Trott May 2, 2017

Choose a reason for hiding this comment

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

I think only Collaborators can label issues, so the people who actually read this guide (that is: non-Collaborators) won't be able to do as instructed (mark something as blocked).

</details>
<details>
<summary><strong>Be aware of our style rules</strong></summary>
Expand Down Expand Up @@ -164,7 +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
- If its not a bug fix, document the motivation for the change.

A good commit log can look something like this:

Expand Down