Skip to content

Commit e897a22

Browse files
author
Jesse Seldess
authored
Merge pull request cockroachdb#3227 from cockroachdb/more-vale-rules
More vale rules
2 parents dec77b3 + 1226967 commit e897a22

File tree

6 files changed

+27
-3
lines changed

6 files changed

+27
-3
lines changed

ci/vale/CockroachDB/Contractions.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
extends: substitution
22
message: Use '%s' instead of '%s'
3+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#language-and-tone
34
ignorecase: false
45
level: warning
56
swap:

ci/vale/CockroachDB/HeadingsCase.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
extends: capitalization
22
message: "'%s' should be in sentence case"
3+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
34
level: warning
45
scope: heading
56
match: $sentence
+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
extends: existence
2-
message: Do not use end punctuation (%s) in headings
2+
message: Do not use '%s' at the end of headings
3+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
34
scope: heading
45
level: warning
56
raw:
6-
- '(?:[^a-zA-Z])$'
7+
- '(?:\:|\.)$'

ci/vale/CockroachDB/Hyperbolic.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
extends: existence
2+
message: Consider removing '%s'
3+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#language-and-tone
4+
ignorecase: true
5+
level: warning
6+
tokens:
7+
- simple
8+
- just
9+
- easily
10+
- actually

ci/vale/CockroachDB/OxfordComma.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
extends: existence
2-
message: 'Use the Oxford comma in a list of three or more items.'
2+
message: Use the Oxford comma in a list of three or more items
3+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
34
level: warning
45
tokens:
56
- '(?:[^,]+,){1,}\s\w+\sand'

ci/vale/CockroachDB/Terminology.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
extends: substitution
2+
message: Prefer '%s' over '%s'
3+
ignorecase: false
4+
level: warning
5+
swap:
6+
cockroachdb: CockroachDB
7+
raft: Raft
8+
admin UI: Admin UI
9+
admin ui: Admin UI
10+
ui: UI

0 commit comments

Comments
 (0)