You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Especially do so if you plan to work on something big. Nothing is more
60
-
frustrating than seeing your hard work go to waste because your vision
61
-
does not align with the project team. (Node.js has two IRC channels:
51
+
Node.js has two IRC channels:
62
52
[#Node.js](http://webchat.freenode.net/?channels=node.js) for general help and
63
53
questions, and
64
54
[#Node-dev](http://webchat.freenode.net/?channels=node-dev) for development of
65
-
Node.js core specifically).
66
-
67
-
For instructions on updating the version of V8 included in the *deps/*
68
-
directory, please refer to [the Maintaining V8 in Node.js guide](https://github.com/nodejs/node/blob/master/doc/guides/maintaining-V8.md).
69
-
55
+
Node.js core specifically.
70
56
71
57
### Step 2: Branch
72
58
@@ -95,35 +81,37 @@ $ git add my/changed/files
95
81
$ git commit
96
82
```
97
83
98
-
### Commit guidelines
84
+
### Commit message guidelines
99
85
100
-
Writing good commit logs is important. A commit log should describe what
101
-
changed and why. Follow these guidelines when writing one:
86
+
The commit message should describe what changed and why.
102
87
103
88
1. The first line should:
104
89
- contain a short description of the change
105
90
- be 50 characters or less
106
91
- be entirely in lowercase with the exception of proper nouns, acronyms, and
107
92
the words that refer to code, like function/variable names
108
93
- be prefixed with the name of the changed subsystem and start with an
109
-
imperative verb. Examples: "net: add localAddress and localPort
110
-
to Socket", "src: fix typos in node_lttng_provider.h"
111
-
- be meaningful; it is what other people see when they
112
-
run `git shortlog` or `git log --oneline`.<br>
113
-
Check the output of `git log --oneline files/you/changed` to find out
114
-
what subsystem (or subsystems) your changes touch
94
+
imperative verb. Check the output of `git log --oneline files/you/changed` to
95
+
find out what subsystems your changes touch.
96
+
97
+
Examples:
98
+
-`net: add localAddress and localPort to Socket`
99
+
-`src: fix typos in node_lttng_provider.h`
100
+
101
+
115
102
2. Keep the second line blank.
116
103
3. Wrap all other lines at 72 columns.
117
-
- If your patch fixes an open issue, you can add a reference to it at the end
118
-
of the log. Use the `Fixes:` prefix and the full issue URL. For other references
0 commit comments