forked from mui/material-ui
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.vale.ini
28 lines (22 loc) · 1.05 KB
/
.vale.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Config vale. More information at https://docs.errata.ai/vale/config
StylesPath = .github/styles
MinAlertLevel = suggestion
# The docs/writing-rules.zip is generated by `pnpm docs:zipRules`
Packages = Google, docs/writing-rules.zip
[*.md]
# Ignore code injection which start with {{...
BlockIgnores = {{.*
BasedOnStyles = writing-rules
# Google:
Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'.
Google.GenderBias = YES # Avoid gendered profession
Google.OxfordComma = YES
Google.Quotes = YES # Commas and periods go inside quotation marks.
Google.Spelling = YES # In general, use American spelling (word ending with 'nised' or 'logue')
Google.We = YES # Try to avoid using first-person plural
Google.Latin = YES # Try to avoid latin expressions e.g. and i.e.
# Those rules are not repected a lot
# Google.Passive = YES # In general, use active voice instead of passive voice.
Google.Will = YES # Avoid using will
# False positives with "1st" nearly no use in our doc
# Google.Units = YES # Put a nonbreaking space between the number and the unit