Skip to content

Commit 8198274

Browse files
committed
Contributing: adding info about vale as a github action
Signed-off-by: Lynette Miles <[email protected]>
1 parent e9255d7 commit 8198274

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,15 @@ the prose of your pull requests and adds suggestions to improve style and clarit
132132
There is a [VSCode plugin for Vale](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode)
133133
which outputs suggestions to the problems pane in the IDE.
134134

135+
The Fluent Bit repository runs Vale as a GitHub Action on updated text in new pull
136+
requests. Vale suggestions, errors, and warnings will display in GitHub on the
137+
**Files changed** page.
138+
135139
[See the Vale tests for Fluent Bit](https://github.com/fluent/fluent-bit-docs/tree/master/vale-styles).
136140

137141
Most Vale tests are at the `suggestion` level and won't block merging.
138142

139-
The following tests are at a `error` level and will prevent merging:
143+
The following tests are at a `error` level and will cause a test failure:
140144

141145
- [AmSpelling](https://developers.google.com/style/word-list)
142146
- [Ampersand](https://developers.google.com/style/word-list#ampersand)

0 commit comments

Comments
 (0)