Skip to content

Commit 454fc3b

Browse files
authored
Merge pull request #2025 from fluent/lynettemiles/sc-143742/update-vale-tests-to-error
2 parents 0cd56a2 + 2a048e9 commit 454fc3b

15 files changed

+32
-20
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ within a few minutes.
4242
If you open a pull request that requires ongoing discussion or review, the Fluent Bit
4343
maintainers will add a `waiting-for-user` to your pull request. This tag means that
4444
we're blocked from moving forward until you reply. To keep contributions from going
45-
stale, we'll wait 45 days for your response, but we may close the pull request if we
45+
stale, we'll wait 45 days for your response, but we might close the pull request if we
4646
don't hear back from you by then.
4747

4848
## Submit a contribution
@@ -140,13 +140,17 @@ The following tests are at a `error` level and will prevent merging:
140140

141141
- [AmSpelling](https://developers.google.com/style/word-list)
142142
- [Ampersand](https://developers.google.com/style/word-list#ampersand)
143+
- [Don'tUse](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/DontUse.yml)
143144
- [Emdash](https://github.com/errata-ai/Google/blob/master/Google/EmDash.yml)
144145
- [Endash](https://github.com/errata-ai/Google/blob/master/Google/EmDash.yml)
145146
- [Exclamation](https://github.com/errata-ai/Google/blob/master/Google/Exclamation.yml)
146147
- [Gender](https://developers.google.com/style/pronouns#gender-neutral-pronouns)
147148
- [GenderBias](https://developers.google.com/style/inclusive-documentation)
149+
- [Hints](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/Hints.yml) using `>`.
148150
- [HeadingPunctuation](https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings)
151+
- [Latin](https://developers.google.com/style/abbreviations)
149152
- [LyHyphens](https://developers.google.com/style/hyphens)
153+
- [MayMightCan](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/MayMightCan.yml)
150154
- [NonStandardQuotes](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/NonStandardQuotes.yml):
151155
[Use standard quotes](https://developers.google.com/style/quotation-marks#straight-and-curly-quotation-marks).
152156
By default, Google Docs and Microsoft Word turn standard straight quotes into "smart"
@@ -155,13 +159,21 @@ The following tests are at a `error` level and will prevent merging:
155159
in [Google Docs](https://support.google.com/docs/thread/217182974/can-i-turn-smart-quotes-off-in-a-google-doc?hl=en)
156160
or [Microsoft Word](https://support.microsoft.com/en-us/office/smart-quotes-in-word-and-powerpoint-702fc92e-b723-4e3d-b2cc-71dedaf2f343)
157161
to prevent this problem.
162+
- [Optional plurals](https://developers.google.com/style/plurals-parentheses)
158163
- [Ordinal](https://developers.google.com/style/numbers)
164+
- [Periods](https://developers.google.com/style/abbreviations)
165+
- [Ranges](https://developers.google.com/style/hyphens)
159166
- [Repetition](https://github.com/errata-ai/vale/blob/v3/testdata/styles/Markup/Repetition.yml):
160167
Checks for the same word used twice in succession.
168+
- [Slang](https://developers.google.com/style/abbreviations)
169+
- [Spacing](https://developers.google.com/style/sentence-spacing)
161170

162171
The following tests are at a `warning` level and won't prevent merging:
163172

164173
- [Ampersand](https://developers.google.com/style/word-list#ampersand)
174+
- [First person](https://developers.google.com/style/pronouns#personal-pronouns)
175+
- [Possessives](https://developers.google.com/style/possessives)
176+
- [Simplicity](https://developers.google.com/style/word-list#easy)
165177

166178
### Markdownlint
167179

MAINTAINERS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fluent Bit Documentation Maintainers
22

3-
Fluent Bit is developed and supported by many individuals and companies. The following table list the names of maintainers per components and the company supporting their work.
3+
Fluent Bit is developed and supported by many individuals and companies. The following table list the names of maintainers per components and the company supporting their work.
44

55
| Maintainer Name | Documentation portion | Company |
66
| :---------------------------------------------------- | ------------------------ | ------------------------------------------------- |
@@ -11,4 +11,3 @@ Fluent Bit is developed and supported by many individuals and companies. The fo
1111
| [Alexa Kreizinger](https://github.com/alexakreizinger) | All | [Chronosphere](https://chronosphere.io) |
1212
| [Paige Cruz](https://github.com/paigerduty) | All | [Chronosphere](https://chronosphere.io/) |
1313
| [Eric D. Schabell](https://github.com/eschabell) | All | [Chronosphere](https://chronosphere.io/) |
14-

vale-styles/FluentBit/DontUse.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
extends: existence
33
message: "We don't use '%s'."
44
ignorecase: true
5-
level: suggestion
5+
level: error
66
tokens:
77
- a.k.a.
88
- aka

vale-styles/FluentBit/FirstPerson.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ extends: existence
22
message: "Avoid first-person pronouns such as '%s'."
33
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
44
ignorecase: true
5-
level: suggestion
5+
level: warning
66
nonword: true
77
tokens:
88
- (?:^|\s)I\s
99
- (?:^|\s)I,\s
1010
- \bI'm\b
1111
- \bme\b
1212
- \bmy\b
13-
- \bmine\b
13+
- \bmine\b

vale-styles/FluentBit/Hints.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: existence
22
message: "Instead of using `>` to call out information, use GitBook hint syntax. https://gitbook.com/docs/creating-content/blocks/hint#representation-in-markdown"
3-
level: suggestion
3+
level: error
44
nonword: true
55
scope: raw
66
tokens:

vale-styles/FluentBit/Latin.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ extends: substitution
22
message: "Use '%s' instead of '%s'."
33
link: 'https://developers.google.com/style/abbreviations'
44
ignorecase: true
5-
level: suggestion
5+
level: error
66
nonword: true
77
action:
88
name: replace

vale-styles/FluentBit/MayMightCan.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
extends: existence
33
message: "Use 'can' for permissions or 'might' for possibility."
4-
level: suggestion
4+
level: error
55
ignorecase: true
66
tokens:
77
- may

vale-styles/FluentBit/OptionalPlurals.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
extends: existence
22
message: "Don't use plurals in parentheses such as in '%s'."
33
link: 'https://developers.google.com/style/plurals-parentheses'
4-
level: suggestion
4+
level: error
55
nonword: true
66
action:
77
name: edit

vale-styles/FluentBit/Periods.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
extends: existence
22
message: "Don't use periods with acronyms or initialisms such as '%s'."
33
link: 'https://developers.google.com/style/abbreviations'
4-
level: suggestion
4+
level: error
55
nonword: true
66
tokens:
7-
- '\b(?:[A-Z]\.){3,}'
7+
- '\b(?:[A-Z]\.){3,}'

vale-styles/FluentBit/Possessives.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
extends: existence
33
message: "Rewrite '%s' to not use 's."
4-
level: suggestion
4+
level: warning
55
ignorecase: true
66
tokens:
77
- Bit's

0 commit comments

Comments
 (0)