Skip to content

Commit 7024ee9

Browse files
committed
Mark down the guidelines for the guidelines as diff syntax
1 parent 2b842b6 commit 7024ee9

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,35 @@ page at http://localhost:3000/.
4141
We follow some basic grammatical rules to ensure that the checklist of
4242
guidelines remains consistent and intelligible.
4343

44-
A guideline is an indicative statement about a hypothetical crate.
44+
A guideline is an **indicative statement** about a hypothetical crate.
4545

46-
- Not an imperative like "Implement Hex, Octal, Binary for binary number types."
47-
Instead: "Binary number types provide Hex, Octal, Binary formatting."
46+
```diff
47+
- Not an imperative like "Implement Hex, Octal, Binary for binary number types"
48+
+ Instead: "Binary number types provide Hex, Octal, Binary formatting"
4849

49-
- Not an obligation like "Macros should compose well with attributes."
50-
Instead: "Macros compose well with attributes."
50+
- Not an obligation like "Macros should compose well with attributes"
51+
+ Instead: "Macros compose well with attributes"
52+
```
5153

52-
Guidelines have an explicit subject and verb.
54+
Guidelines have an explicit **subject** and **verb**.
5355

54-
- Not implicit subject like "Includes all common Cargo.toml metadata."
55-
Instead: "Cargo.toml includes all common metadata."
56+
```diff
57+
- Not implicit subject like "Includes all common Cargo.toml metadata"
58+
+ Instead: "Cargo.toml includes all common metadata"
5659

57-
- Not implicit verb like "Thoroughly documented with examples."
58-
Instead: "Crate level docs are thorough and include examples."
60+
- Not implicit verb like "Thoroughly documented with examples"
61+
+ Instead: "Crate level docs are thorough and include examples"
5962

60-
- Not metaphysical like "There are no out-parameters."
61-
Instead: "Functions do not take out-parameters."
63+
- Not metaphysical like "There are no out-parameters"
64+
+ Instead: "Functions do not take out-parameters"
65+
```
6266

63-
Guidelines use active voice.
67+
Guidelines use **active voice**.
6468

65-
- Not passive voice like "Function arguments are validated."
66-
Instead: "Functions validate their arguments."
69+
```diff
70+
- Not passive voice like "Function arguments are validated"
71+
+ Instead: "Functions validate their arguments"
72+
```
6773

6874
## Conduct
6975

0 commit comments

Comments
 (0)