summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/Contractions.yml
blob: dc48b876f4045e611200e814b76ff1830994e3a5 (plain)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
# Suggestion: gitlab.Contractions
#
# Checks for use of common and uncommon contractions.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
message: 'Use "%s" instead of "%s", for a friendly, informal tone.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
level: suggestion
nonword: false
ignorecase: true
swap:

  # Common contractions are ok
  it is: it's
  can not: can't
  cannot: can't
  do not: don't
  have not: haven't
  that is: that's
  we are: we're
  would not: wouldn't
  you are: you're
  you have: you've

  # Uncommon contractions are not ok
  aren't: are not
  couldn't: could not
  didn't: did not
  doesn't: does not
  hasn't: has not
  how's: how is
  isn't: is not
  shouldn't: should not
  they're: they are
  wasn't: was not
  weren't: were not
  we've: we have
  what's: what is
  when's: when is
  where's: where is
  who's: who is
  why's: why is