Skip to content

Commit cb315ea

Browse files
authored
Merge pull request #4069 from replicatedhq/vale-linter
update heading rules in the vale linter
2 parents 5f7530a + 90c81e7 commit cb315ea

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

.claude/skills/vale-prose-review/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ See `references/vale-rules.md` for full fix patterns, before/after examples, and
117117

118118
**`Replicated.PositionalLanguage`** — Replace "above/below" with "the following" or a section link; replace directional "right/left" with "the following" or a UI element name.
119119

120-
**`Replicated.Headings`** — Apply sentence case, with three exceptions: (1) **Skip entirely** when the heading IS a CLI command name or YAML field name (e.g., `# install (Beta)`, `## helmCharts`) — those follow the thing's own casing conventions. (2) **Parentheticals reset sentence case**`(Beta)` is correct, not `(beta)`. (3) **Kubernetes custom resource kind names stay capitalized**`Preflight`, `SupportBundle`, `Config`, `HelmChart` are proper names; check context to confirm the word refers to a `kind:` value before lowercasing. See `references/vale-rules.md` for full patterns.
120+
**`Replicated.Headings`** — Apply sentence case, with three exceptions: (1) **Skip entirely** when the heading IS a CLI command name or YAML field name (e.g., `# install (Beta)`, `## helmCharts`) — those follow the thing's own casing conventions. (2) **Parentheticals reset sentence case**`(Beta)` and `(Alpha)` are correct; **never** lowercase to `(beta)` or `(alpha)`. (3) **Kubernetes custom resource kind names stay capitalized**`Preflight`, `SupportBundle`, `Config`, `HelmChart` are proper names; check context to confirm the word refers to a `kind:` value before lowercasing. See `references/vale-rules.md` for full patterns.
121121

122122
**`Replicated.WordsToAvoid`** — Remove "easy/easily", "simple/simply", "just" (when minimizing). Rephrase or omit.
123123

.claude/skills/vale-prose-review/references/vale-rules.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,13 @@ Do NOT apply sentence case to headings that are the exact name of a CLI command,
128128

129129
### Parentheticals reset sentence case
130130

131-
A parenthetical like `(Beta)` or `(Preview)` opens a new "sentence" within the heading. Capitalize the first word inside the parenthetical.
131+
A parenthetical like `(Beta)` or `(Preview)` opens a new "sentence" within the heading. **Always capitalize the first word inside the parenthetical — do NOT lowercase it when applying sentence case to the rest of the heading.**
132132

133-
- `(Beta)` is correct — **not** `(beta)`
134-
- `(Preview)` is correct — **not** `(preview)`
135-
- `(Deprecated)` is correct — **not** `(deprecated)`
133+
- `(Beta)` is correct — **never** `(beta)`
134+
- `(Alpha)` is correct — **never** `(alpha)`
135+
- `(Deprecated)` is correct — **never** `(deprecated)`
136+
137+
> **Common mistake:** When applying `Replicated.Headings` sentence-case fixes, do not treat parenthetical words as mid-sentence words subject to lowercasing. `## This is a heading (Beta)` stays `## This is a heading (Beta)` — the `B` in `Beta` must remain uppercase.
136138
137139
### Kubernetes custom resource kinds — always capitalize
138140

0 commit comments

Comments
 (0)