Skip to content

Commit 1b2c61d

Browse files
authored
Merge pull request #213 from waldyrious/patch-1
CONTRIBUTING.md: use context lines in diff blocks
2 parents 86bd10c + 1358cf5 commit 1b2c61d

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,31 +44,43 @@ guidelines remains consistent and intelligible.
4444
A guideline is an **indicative statement** about a hypothetical crate.
4545

4646
```diff
47-
- Not an imperative like "Implement Hex, Octal, Binary for binary number types"
48-
+ Instead: "Binary number types provide Hex, Octal, Binary formatting"
49-
50-
- Not an obligation like "Macros should compose well with attributes"
51-
+ Instead: "Macros compose well with attributes"
47+
Not an imperative like
48+
- "Implement Hex, Octal, Binary for binary number types"
49+
Instead:
50+
+ "Binary number types provide Hex, Octal, Binary formatting"
51+
52+
Not an obligation like
53+
- "Macros should compose well with attributes"
54+
Instead:
55+
+ "Macros compose well with attributes"
5256
```
5357

5458
Guidelines have an explicit **subject** and **verb**.
5559

5660
```diff
57-
- Not implicit subject like "Includes all common Cargo.toml metadata"
58-
+ Instead: "Cargo.toml includes all common metadata"
59-
60-
- Not implicit verb like "Thoroughly documented with examples"
61-
+ Instead: "Crate level docs are thorough and include examples"
62-
63-
- Not metaphysical like "There are no out-parameters"
64-
+ Instead: "Functions do not take out-parameters"
61+
Not implicit subject like
62+
- "Includes all common Cargo.toml metadata"
63+
Instead:
64+
+ "Cargo.toml includes all common metadata"
65+
66+
Not implicit verb like
67+
- "Thoroughly documented with examples"
68+
Instead:
69+
+ "Crate level docs are thorough and include examples"
70+
71+
Not metaphysical like
72+
- "There are no out-parameters"
73+
Instead:
74+
+ "Functions do not take out-parameters"
6575
```
6676

6777
Guidelines use **active voice**.
6878

6979
```diff
70-
- Not passive voice like "Function arguments are validated"
71-
+ Instead: "Functions validate their arguments"
80+
Not passive voice like
81+
- "Function arguments are validated"
82+
Instead:
83+
+ "Functions validate their arguments"
7284
```
7385

7486
## Conduct

0 commit comments

Comments
 (0)