Skip to content

Commit 6833b28

Browse files
author
Matthew Fisher
committed
docs(standards): use proper english
Some of the sentences in the documentation is poorly written.
1 parent 88a32c5 commit 6833b28

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

docs/contributing/standards.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ When bisecting, you can ignore these by running:
146146
Providing more Information when Browsing the History
147147
````````````````````````````````````````````````````
148148

149-
This would add kinda “context” information. Look at these messages (taken from last few
150-
angular’s commits):
149+
This adds extra context to our commit logs. Look at these messages (taken from the last
150+
few AngularJS commits):
151151

152152
- Fix small typo in docs widget (tutorial instructions)
153153
- Fix test for scenario.Application - should remove old iframe
@@ -156,20 +156,21 @@ angular’s commits):
156156
- Replaced double line break with single when text is fetched from Google
157157
- Added support for properties in documentation
158158

159-
All of these messages try to specify where is the change. But they don’t share any
160-
convention. Look at these messages:
159+
All of these messages try to specify where the change occurs, but they don’t share any
160+
convention. Now look at these messages:
161161

162162
- fix comment stripping
163163
- fixing broken links
164164
- Bit of refactoring
165165
- Check whether links do exist and throw exception
166166
- Fix sitemap include (to work on case sensitive linux)
167167

168-
Are you able to guess what’s inside?
168+
Are you able to guess what’s inside each commit diff?
169169

170170
It's true that you can find this information by checking which files had been changed, but
171-
that’s slow. And when looking in git history I can see all of us tries to specify the
172-
place, only missing the convention. Cue commit message formatting entrance stage left.
171+
that’s slow. When looking in the git history, we can see that all of the developers are
172+
trying to specify where the change takes place, but the message is missing a convention.
173+
Cue commit message formatting entrance stage left.
173174

174175
Format of the Commit Message
175176
````````````````````````````

0 commit comments

Comments
 (0)