Skip to content

Commit 377eed5

Browse files
author
MarcoFalke
committed
Merge #18170: doc: Minor grammatical changes and flow improvements
7ba9622 doc: Minor grammatical changes and flow improvements (Travin Keith) Pull request description: **Grammar:** Line 49: There shouldn't be a period at the end of a phrase. Lines 56, 57, 116, 137, and 177: Adding necessary commas Lines 103 and 136: Run-on sentence issues fixed. Line 176: Fixed punctuation and added necessary conjunction Line 178: Singular noun when it should be plural **Flow:** Line 49: Adding "for" makes it more natural. Line 54: Though it's not grammatically incorrect to end a sentence with a preposition in an informal document such as this, the word "followed" is much easier to understand anyway, especially for those who don't have English as their native language. Top commit has no ACKs. Tree-SHA512: 17fdb5fc6146e025f160e860dbcbdbfa07b7608b8cb611c3b9d4ed91c426100ef772915251bc1f6bacb3a62df57b72c2003fb72cb2c8542454638545985313da
2 parents 90b3e59 + 7ba9622 commit 377eed5

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ facilitates social contribution, easy testing and peer review.
4646

4747
To contribute a patch, the workflow is as follows:
4848

49-
1. Fork repository ([only the first time](https://help.github.com/en/articles/fork-a-repo)).
49+
1. Fork repository ([only for the first time](https://help.github.com/en/articles/fork-a-repo))
5050
1. Create topic branch
5151
1. Commit patches
5252

5353
The project coding conventions in the [developer notes](doc/developer-notes.md)
54-
must be adhered to.
54+
must be followed.
5555

56-
In general [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
57-
and diffs should be easy to read. For this reason do not mix any formatting
56+
In general, [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
57+
and diffs should be easy to read. For this reason, do not mix any formatting
5858
fixes or code moves with actual code changes.
5959

6060
Commit messages should be verbose by default consisting of a short subject line
@@ -100,7 +100,7 @@ Examples:
100100
qt: Add feed bump button
101101
log: Fix typo in log message
102102

103-
Note that translations should not be submitted as pull requests, please see
103+
Note that translations should not be submitted as pull requests. Please see
104104
[Translation Process](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md)
105105
for more information on helping with translations.
106106

@@ -113,7 +113,7 @@ patch does together with any justification/reasoning. You should include
113113
references to any discussions (for example other tickets or mailing list
114114
discussions).
115115

116-
At this stage one should expect comments and review from other contributors. You
116+
At this stage, one should expect comments and review from other contributors. You
117117
can add more commits to your pull request by committing them locally and pushing
118118
to your fork until you have satisfied all feedback.
119119

@@ -133,8 +133,8 @@ before it will be merged. The basic squashing workflow is shown below.
133133
# Save and quit.
134134
git push -f # (force push to GitHub)
135135

136-
Please update the resulting commit message if needed, it should read as a
137-
coherent message. In most cases this means that you should not just list the
136+
Please update the resulting commit message if needed. It should read as a
137+
coherent message. In most cases, this means that you should not just list the
138138
interim commits.
139139

140140
If you have problems with squashing (or other workflows with `git`), you can
@@ -173,9 +173,9 @@ in the future, they may be removed by the Repository Maintainer.
173173
Refactoring is a necessary part of any software project's evolution. The
174174
following guidelines cover refactoring pull requests for the project.
175175

176-
There are three categories of refactoring, code only moves, code style fixes,
177-
code refactoring. In general refactoring pull requests should not mix these
178-
three kinds of activity in order to make refactoring pull requests easy to
176+
There are three categories of refactoring: code-only moves, code style fixes, and
177+
code refactoring. In general, refactoring pull requests should not mix these
178+
three kinds of activities in order to make refactoring pull requests easy to
179179
review and uncontroversial. In all cases, refactoring PRs must not change the
180180
behaviour of code within the pull request (bugs must be preserved as is).
181181

0 commit comments

Comments
 (0)