Skip to content

Adding crosslinks for the vale test #1622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 30, 2025
Merged

Adding crosslinks for the vale test #1622

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85fb69b
Adding crosslinks for the vale test
esmerel Apr 30, 2025
79190f7
Update CONTRIBUTING.md
esmerel Apr 30, 2025
08bfa90
Update CONTRIBUTING.md
esmerel Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.