Skip to content

Commit

Permalink
馃摑 docs(website): update rule comments on examples
Browse files Browse the repository at this point in the history
Should've been done in #12.
  • Loading branch information
welpo committed Feb 12, 2024
1 parent 60131ba commit 7dd8add
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions website/docs/examples.md
Expand Up @@ -11,19 +11,23 @@ Tim Pope ([@tpope](https://github.com/tpope)) is a prolific author of many popul
To follow his advice, you can use the following configuration:

```toml
# Process each non-empty line in the commit message as an individual commit.
# Processes each non-empty line as an individual commit.
split_lines = false

# Rule: commit description must start with the specified case. Options: "any", "lower", "upper".
# Rule: Description must start with the specified case.
# Options: 'any', 'lower', 'upper'.
description_case = "upper"

# Rule: use the imperative mood in the description (e.g. "Fix bug" instead of "Fixed bug").
# Rule: Use the imperative mood in the description.
# Example: 'Fix bug' instead of 'Fixed bug'.
imperative = true

# Rule: limit the header to the specified length. A value of 0 disables this rule.
# Rule: Header length limit.
# A value of 0 disables the rule.
max_header_length = 50

# Rule: wrap the body at the specified length. A value of 0 disables this rule.
# Rule: Body line length limit.
# A value of 0 disables the rule.
max_body_length = 72
```

Expand All @@ -34,12 +38,14 @@ Linus Torvalds ([@torvalds](https://github.com/torvalds)) is the principal autho
This configuration will ensure you follow his advice:

```toml
# Rule: use the imperative mood in the description (e.g. "Fix bug" instead of "Fixed bug").
# Rule: Use the imperative mood in the description.
# Example: 'Fix bug' instead of 'Fixed bug'.
imperative = true

# Rule: wrap the body at the specified length. A value of 0 disables this rule.
# Rule: Body line length limit.
# A value of 0 disables the rule.
max_body_length = 74

# Rule: disallow leading/trailing whitespace and consecutive spaces.
# Rule: No leading, trailing, or consecutive spaces.
whitespace = true
```

0 comments on commit 7dd8add

Please sign in to comment.