Skip to content

CONTRIBUTING.md: use context lines in diff blocks #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 19, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 27 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,31 +44,43 @@ guidelines remains consistent and intelligible.
A guideline is an **indicative statement** about a hypothetical crate.

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

- Not an obligation like "Macros should compose well with attributes"
+ Instead: "Macros compose well with attributes"
Not an imperative like
- "Implement Hex, Octal, Binary for binary number types"
Instead:
+ "Binary number types provide Hex, Octal, Binary formatting"

Not an obligation like
- "Macros should compose well with attributes"
Instead:
+ "Macros compose well with attributes"
```

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

```diff
- Not implicit subject like "Includes all common Cargo.toml metadata"
+ Instead: "Cargo.toml includes all common metadata"

- Not implicit verb like "Thoroughly documented with examples"
+ Instead: "Crate level docs are thorough and include examples"

- Not metaphysical like "There are no out-parameters"
+ Instead: "Functions do not take out-parameters"
Not implicit subject like
- "Includes all common Cargo.toml metadata"
Instead:
+ "Cargo.toml includes all common metadata"

Not implicit verb like
- "Thoroughly documented with examples"
Instead:
+ "Crate level docs are thorough and include examples"

Not metaphysical like
- "There are no out-parameters"
Instead:
+ "Functions do not take out-parameters"
```

Guidelines use **active voice**.

```diff
- Not passive voice like "Function arguments are validated"
+ Instead: "Functions validate their arguments"
Not passive voice like
- "Function arguments are validated"
Instead:
+ "Functions validate their arguments"
```

## Conduct
Expand Down