Skip to content

Commit 9f3e2fe

Browse files
committed
Merge branch 'rg/doc-submittingpatches-wordfix'
* rg/doc-submittingpatches-wordfix: doc: update SubmittingPatches
2 parents 741eaf7 + 01e60a9 commit 9f3e2fe

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation/SubmittingPatches

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If your description starts to get too long, that's a sign that you
5151
probably need to split up your commit to finer grained pieces.
5252
That being said, patches which plainly describe the things that
5353
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
5555
the point in the subject well, and describe the motivation for the
5656
change, the approach taken by the change, and if relevant how this
5757
differs substantially from the prior version, are all good things
@@ -87,7 +87,7 @@ patches separate from other documentation changes.
8787
Oh, another thing. We are picky about whitespaces. Make sure your
8888
changes do not trigger errors with the sample pre-commit hook shipped
8989
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.
9191

9292

9393
(2) Describe your changes well.
@@ -111,18 +111,18 @@ Improve...".
111111

112112
The body should provide a meaningful commit message, which:
113113

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
115115
with the current code without the change.
116116

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
118118
result with the change is better.
119119

120120
. alternate solutions considered but discarded, if any.
121121

122122
Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
123123
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
124124
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
126126
without external resources. Instead of giving a URL to a mailing list
127127
archive, summarize the relevant points of the discussion.
128128

@@ -261,7 +261,7 @@ smaller project it is a good discipline to follow it.
261261
The sign-off is a simple line at the end of the explanation for
262262
the patch, which certifies that you wrote it or otherwise have
263263
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:
265265

266266
Developer's Certificate of Origin 1.1
267267

0 commit comments

Comments
 (0)