Skip to content

Commit 329b538

Browse files
committed
doc: update CONTRIBUTING.md
* Latest stable is v0.10 now. * Add example of what the first line of the commit log should look like.
1 parent 9fae4dc commit 329b538

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ Okay, so you have decided on the proper branch. Create a feature branch
4949
and start hacking:
5050

5151
```
52-
$ git checkout -b my-feature-branch -t origin/v0.8
52+
$ git checkout -b my-feature-branch -t origin/v0.10
5353
```
5454

55-
(Where v0.8 is the latest stable branch as of this writing.)
55+
(Where v0.10 is the latest stable branch as of this writing.)
5656

5757

5858
### COMMIT
@@ -68,14 +68,15 @@ Writing good commit logs is important. A commit log should describe what
6868
changed and why. Follow these guidelines when writing one:
6969

7070
1. The first line should be 50 characters or less and contain a short
71-
description of the change.
71+
description of the change prefixed with the name of the changed
72+
subsystem (e.g. "net: add localAddress and localPort to Socket").
7273
2. Keep the second line blank.
7374
3. Wrap all other lines at 72 columns.
7475

7576
A good commit log looks like this:
7677

7778
```
78-
Header line: explaining the commit in one line
79+
subsystem: explaining the commit in one line
7980
8081
Body of commit message is a few lines of text, explaining things
8182
in more detail, possibly giving some background about the issue
@@ -99,7 +100,7 @@ Use `git rebase` (not `git merge`) to sync your work from time to time.
99100

100101
```
101102
$ git fetch upstream
102-
$ git rebase upstream/v0.8 # or upstream/master
103+
$ git rebase upstream/v0.10 # or upstream/master
103104
```
104105

105106

0 commit comments

Comments
 (0)