Skip to content

Commit 74fdf73

Browse files
committedJun 14, 2015
doc: copyedit COLLABORATOR_GUIDE.md
PR-URL: #1964 Reviewed-By: Alex Kocharin <[email protected]> Reviewed-By: Johan Bergström <[email protected]>
1 parent 5fe6e83 commit 74fdf73

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed
 

‎COLLABORATOR_GUIDE.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ exactly how to format your commit messages.
101101

102102
Additionally:
103103

104-
- Double check PR's to make sure the person's _full name_ and email
104+
- Double check PRs to make sure the person's _full name_ and email
105105
address are correct before merging.
106106
- Except when updating dependencies, all commits should be self
107-
contained. Meaning, every commit should pass all tests. This makes
107+
contained (meaning every commit should pass all tests). This makes
108108
it much easier when bisecting to find a breaking change.
109109

110110
### Technical HOWTO
@@ -148,8 +148,8 @@ $ git log origin/master...master
148148
```
149149

150150
If there are multiple commits that relate to the same feature or
151-
one with a feature and separate with a test for that feature -
152-
you'll need to squash them (or strictly speaking `fixup`).
151+
one with a feature and separate with a test for that feature,
152+
you'll need to use `squash` or `fixup`:
153153

154154
```text
155155
$ git rebase -i origin/master
@@ -201,11 +201,10 @@ reword 51759dc feature B
201201
fixup 7d6f433 test for feature B
202202
```
203203

204-
Save the file and close the editor, you'll be asked to enter new
205-
commit message for that commit, and everything else should go
206-
smoothly. Note that this is a good moment to fix incorrect commit
207-
logs, ensure that they are properly formatted, and add `Reviewed-By`
208-
line.
204+
Save the file and close the editor. You'll be asked to enter a new
205+
commit message for that commit. This is a good moment to fix incorrect
206+
commit logs, ensure that they are properly formatted, and add
207+
`Reviewed-By` lines.
209208

210209
Time to push it:
211210

@@ -215,11 +214,11 @@ $ git push origin master
215214

216215
### I just made a mistake
217216

218-
With git, there's a way to override remote trees by force pushing
217+
With `git`, there's a way to override remote trees by force pushing
219218
(`git push -f`). This should generally be seen as forbidden (since
220219
you're rewriting history on a repository other people are working
221220
against) but is allowed for simpler slip-ups such as typos in commit
222221
messages. However, you are only allowed to force push to any io.js
223222
branch within 10 minutes from your original push. If someone else
224-
pushes to the branch your commit lives in or the 10 minute period
225-
passes, consider the commit final.
223+
pushes to the branch or the 10 minute period passes, consider the
224+
commit final.

0 commit comments

Comments
 (0)
Please sign in to comment.