@@ -51,7 +51,7 @@ If your description starts to get too long, that's a sign that you
51
51
probably need to split up your commit to finer grained pieces.
52
52
That being said, patches which plainly describe the things that
53
53
help reviewers check the patch, and future maintainers understand
54
- the code, are the most beautiful patches. Descriptions that summarise
54
+ the code, are the most beautiful patches. Descriptions that summarize
55
55
the point in the subject well, and describe the motivation for the
56
56
change, the approach taken by the change, and if relevant how this
57
57
differs substantially from the prior version, are all good things
@@ -87,7 +87,7 @@ patches separate from other documentation changes.
87
87
Oh, another thing. We are picky about whitespaces. Make sure your
88
88
changes do not trigger errors with the sample pre-commit hook shipped
89
89
in templates/hooks--pre-commit. To help ensure this does not happen,
90
- run git diff --check on your changes before you commit.
90
+ run " git diff --check" on your changes before you commit.
91
91
92
92
93
93
(2) Describe your changes well.
@@ -111,18 +111,18 @@ Improve...".
111
111
112
112
The body should provide a meaningful commit message, which:
113
113
114
- . explains the problem the change tries to solve, iow, what is wrong
114
+ . explains the problem the change tries to solve, i.e. what is wrong
115
115
with the current code without the change.
116
116
117
- . justifies the way the change solves the problem, iow, why the
117
+ . justifies the way the change solves the problem, i.e. why the
118
118
result with the change is better.
119
119
120
120
. alternate solutions considered but discarded, if any.
121
121
122
122
Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
123
123
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
124
124
to do frotz", as if you are giving orders to the codebase to change
125
- its behaviour . Try to make sure your explanation can be understood
125
+ its behavior . Try to make sure your explanation can be understood
126
126
without external resources. Instead of giving a URL to a mailing list
127
127
archive, summarize the relevant points of the discussion.
128
128
@@ -261,7 +261,7 @@ smaller project it is a good discipline to follow it.
261
261
The sign-off is a simple line at the end of the explanation for
262
262
the patch, which certifies that you wrote it or otherwise have
263
263
the right to pass it on as a open-source patch. The rules are
264
- pretty simple: if you can certify the below:
264
+ pretty simple: if you can certify the below D-C-O :
265
265
266
266
Developer's Certificate of Origin 1.1
267
267
0 commit comments