diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69165a92f..1879cd837 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,10 +124,15 @@ possible. For example: The Fluent Bit maintainers use the [Vale](https://vale.sh/docs/) plugin, which lints pull requests and adds suggestions to improve style and clarity. Most Vale tests are -at the `suggestion` level and will not block merging. - -The following tests are at a `warning` level and will prevent merging: - -- NonStandardQuotes: Use standard quotes. Google docs use curly quotes. Copy and - pasting from Google docs requires correcting the quotes. You can - [turn off smart quotes](https://support.google.com/docs/thread/217182974/can-i-turn-smart-quotes-off-in-a-google-doc?hl=en). +at the `suggestion` level and won't block merging. + +The following tests are at a `error` level and will prevent merging: + +- [NonStandardQuotes](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/NonStandardQuotes.yml): + [Use standard quotes](https://developers.google.com/style/quotation-marks#straight-and-curly-quotation-marks). + By default, Google Docs and Microsoft Word turn standard straight quotes into "smart" + curly quotes. If you copy-paste from one of these tools, you must correct the quotes + back to straight quotes. You can also turn off smart quotes + in [Google Docs](https://support.google.com/docs/thread/217182974/can-i-turn-smart-quotes-off-in-a-google-doc?hl=en) + or [Microsoft Word](https://support.microsoft.com/en-us/office/smart-quotes-in-word-and-powerpoint-702fc92e-b723-4e3d-b2cc-71dedaf2f343) + to prevent this problem.