Skip to content

Commit 9ff8d3a

Browse files
committed
chore: small adjustments to style guide
Signed-off-by: michaelntech <[email protected]>
1 parent bed67de commit 9ff8d3a

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README-styleguide.markdown

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,19 @@ Examples:
6161
> * "helps" rather than "facilitates"
6262
> * "uses" rather than "utilizes."
6363
64-
## Active voice is preferred over passive voice
64+
## Prefer active over passive voice
6565

6666
Unless one of the following applies:
6767

6868
* The system performs the action.
6969
* It is more appropriate to focus on the receiver of the action.
7070
* You want to avoid blaming the user for an error, such as in an error message.
7171
* The information is clearer in passive voice.
72-
* Avoid -ing endings if possible as they make the sentence longer and more passive / less actionable. Examples:.
73-
* "Get started", not "Getting started".
74-
* "Provision a new device", not "Provisioning a new device".
72+
* Avoid -ing endings if possible as they make the sentence longer and more passive / less actionable. Examples:
73+
74+
* "Get started", not "Getting started".
75+
* "Provision a new device", not "Provisioning a new device".
76+
7577
* Helpful resource: the section titled "Passive Voice Should Never Be Used by
7678
You" in the [Linux Journal Author's
7779
Guide](https://www.linuxjournal.com/author/authguide).
@@ -130,8 +132,9 @@ Examples:
130132
* Numbers >=10 to be written as numbers.
131133
* Use a comma separate large numbers (e.g. 10,000).
132134
* Exceptions: avoid mixing number formats in same sentence.
133-
* Don't write: "...while three of our customers have over 20,000 devices...".
134-
* Do write: "...while 3 of our customers have over 20,000 devices...".
135+
136+
* Don't write: "...while three of our customers have over 20,000 devices...".
137+
* Do write: "...while 3 of our customers have over 20,000 devices...".
135138

136139
## Use present tense as much as possible
137140

@@ -176,11 +179,11 @@ Our taxonomy reference can be found [here](02.Overview/15.Taxonomy/docs.md).
176179

177180
Open links in the current tab:
178181

179-
> [https://docs.mender.io](https://docs.mender.io)
182+
> `[https://docs.mender.io](https://docs.mender.io)`
180183
181184
And in a new tab:
182185

183-
> [https://docs.mender.io](https://docs.mender.io?target=_blank)
186+
> `[https://hub.mender.io](https://hub.mender.io?target=_blank)`
184187
185188

186189

0 commit comments

Comments
 (0)