Skip to content

Commit f077884

Browse files
ChrisChinchillaChrisChinchilla
authored
Merge pull request #2 from dylan-k/master
Transfer from styles repo
2 parents 1c8b399 + 4ad1d1a commit f077884

32 files changed

+345
-0
lines changed

‎openly/A11Y.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
extends: substitution
3+
message: Consider using '%s' instead of '%s'
4+
ignorecase: true
5+
level: error
6+
swap:
7+
(?:click|press): "'select'"

‎openly/Ages.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
extends: existence
3+
message: 'Avoid hyphens in ages unless it clarifies the text.'
4+
level: warning
5+
tokens:
6+
- '\d{1,3}-year-old'

‎openly/Anthropomorphism.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
extends: existence
3+
ignorecase: true
4+
level: warning
5+
message: "Don't attribute human qualities to software or hardware."
6+
raw:
7+
- \b(?:PC|computer|object|machine|software|hardware|data|database|engine|message|command|interface)\b\s*
8+
tokens:
9+
- sees
10+
- tells
11+
- thinks
12+
- wants
13+
- cares
14+
- realizes
15+
- assumes
16+
- knows
17+
- remembers
18+
- decides
19+
- knows
20+
- refuses
21+
- demands
22+
- understands
23+
- behaves

‎openly/But.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
extends: existence
3+
message: "Do not start a paragraph with a 'but'."
4+
level: error
5+
scope: paragraph
6+
tokens:
7+
- ^But

‎openly/Clarity.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
extends: substitution
3+
message: Consider using '%s' instead of '%s'
4+
level: warning
5+
ignorecase: false
6+
# swap maps tokens in form of bad: good
7+
swap:
8+
help: assist

‎openly/E-Prime.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
extends: existence
3+
message: 'Avoid using "%s"'
4+
ignorecase: true
5+
level: suggestion
6+
tokens:
7+
- am
8+
- aren't
9+
- being
10+
- he's
11+
- here's
12+
- here's
13+
- how's
14+
- i'm
15+
- isn't
16+
- she's
17+
- that's
18+
- there's
19+
- they're
20+
- wasn't
21+
- we're
22+
- weren't
23+
- what's
24+
- where's
25+
- who's
26+
- you're
27+
- foobar

‎openly/FutureTense.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
extends: existence
3+
message: "Possible future tense."
4+
ignorecase: true
5+
level: warning
6+
tokens:
7+
- will
8+
- '[\w][ll]'
9+
- we are going

‎openly/GenderBias.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
extends: substitution
3+
message: Consider using '%s' instead of '%s'
4+
ignorecase: true
5+
level: error
6+
swap:
7+
(?:alumna|alumnus): graduate
8+
(?:alumnae|alumni): graduates
9+
(?:mother|father)land: native land
10+
(?:mother|father)tongue: native tongue
11+
air(?:m[ae]n|wom[ae]n): pilot(s)
12+
anchor(?:m[ae]n|wom[ae]n): anchor(s)
13+
authoress: author
14+
business(?:m[ae]n|wom[ae]n): business person
15+
camera(?:m[ae]n|wom[ae]n): camera operator(s)
16+
chair(?:m[ae]n|wom[ae]n): chair(s)
17+
congress(?:m[ae]n|wom[ae]n): member(s) of congress
18+
door(?:m[ae]n|wom[ae]n): concierge(s)
19+
drafts(?:m[ae]n|wom[ae]n): drafter(s)
20+
fire(?:m[ae]n|wom[ae]n): firefighter(s)
21+
fisher(?:m[ae]n|wom[ae]n): fisher(s)
22+
fresh(?:m[ae]n|wom[ae]n): first-year student(s)
23+
garbage(?:m[ae]n|wom[ae]n): waste collector(s)
24+
guys: everyone
25+
lady lawyer: lawyer
26+
ladylike: courteous
27+
landlord: building manager
28+
mail(?:m[ae]n|wom[ae]n): mail carriers
29+
man and wife: husband and wife
30+
man enough: strong enough
31+
mankind: human kind
32+
manpower: human resources
33+
manmade: manufactured
34+
men and girls: men and women
35+
middle(?:m[ae]n|wom[ae]n): intermediary
36+
news(?:m[ae]n|wom[ae]n): journalist(s)
37+
ombuds(?:man|woman): ombuds
38+
oneupmanship: upstaging
39+
poetess: poet
40+
police(?:m[ae]n|wom[ae]n): police officer(s)
41+
repair(?:m[ae]n|wom[ae]n): technician(s)
42+
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
43+
service(?:m[ae]n|wom[ae]n): soldier(s)
44+
steward(?:ess)?: flight attendant
45+
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
46+
waitress: waiter
47+
woman doctor: doctor
48+
woman scientist[s]?: scientist(s)
49+
work(?:m[ae]n|wom[ae]n): worker(s)

‎openly/HeadingsPunctuation.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
extends: existence
3+
message: Do not use '%s' at the end of headings
4+
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
5+
scope: heading
6+
level: warning
7+
raw:
8+
- '(?:\:|\.)$'

‎openly/Hedging.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
extends: existence
3+
message: "Consider removing '%s'"
4+
ignorecase: true
5+
level: warning
6+
tokens:
7+
- appear to be
8+
- arguably
9+
- as far as I know
10+
- could
11+
- from my point of view
12+
- hopefully
13+
- I believe
14+
- I doubt
15+
- I think
16+
- in general
17+
- In my opinion
18+
- likely
19+
- might
20+
- more or less
21+
- perhaps
22+
- possibly
23+
- presumably
24+
- probably
25+
- seem(s)?
26+
- somewhat
27+
- to my knowledge
28+
- unlikely
29+
- usually

0 commit comments

Comments
 (0)