@@ -41,29 +41,35 @@ page at http://localhost:3000/.
41
41
We follow some basic grammatical rules to ensure that the checklist of
42
42
guidelines remains consistent and intelligible.
43
43
44
- A guideline is an indicative statement about a hypothetical crate.
44
+ A guideline is an ** indicative statement** about a hypothetical crate.
45
45
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"
48
49
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
+ ```
51
53
52
- Guidelines have an explicit subject and verb.
54
+ Guidelines have an explicit ** subject** and ** verb** .
53
55
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"
56
59
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"
59
62
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
+ ```
62
66
63
- Guidelines use active voice.
67
+ Guidelines use ** active voice** .
64
68
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
+ ```
67
73
68
74
## Conduct
69
75
0 commit comments