Skip to content

Commit 1985379

Browse files
authored
Merge pull request #1622 from fluent/lynettemiles/sc-134476/make-a-crosslink-from-fluent-contrib-for
2 parents 32989ec + 08bfa90 commit 1985379

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,15 @@ possible. For example:
124124

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

0 commit comments

Comments
 (0)