Skip to content

Commit e62382f

Browse files
authored
Add Microsoft style guides and configuration files
1 parent 6745634 commit e62382f

File tree

6 files changed

+93
-1
lines changed

6 files changed

+93
-1
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
StylesPath = styles
2+
Packages = Microsoft, alex
3+
4+
[*.md]
5+
BasedOnStyles = Vale, Microsoft, alex
6+
7+
alex.Ablist = NO # Doesn't apply to our content
8+
alex.ProfanityLikely = NO # Doesn't apply to our content
9+
alex.ProfanityMaybe = NO # Doesn't apply to our content
10+
alex.ProfanityUnlikely = NO # Doesn't apply to our content
11+
12+
Microsoft.HeadingAcronyms = NO # Too noisy for our docset
13+
Microsoft.Headings = NO # Too noisy for our docset
14+
Microsoft.Passive = NO # Too noisy
15+
Microsoft.Negative = NO # Prefer to not use endash
16+
Microsoft.Spacing = NO # Use PowerShell-Docs rule
17+
Microsoft.We = NO # Too noisy when we want to use First Person
18+
Microsoft.Vocab = NO # Too noisy
19+
Microsoft.RangeFormat = NO # Doesn't apply for markdown
20+
Microsoft.Ranges = NO # Doesn't apply for markdown
21+
Microsoft.GeneralURL = NO # Doesn't apply for our audience
22+
23+
; PowerShell-Docs.Passive = NO # Too noisy
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
extends: existence
2+
message: "Don't use '%s'."
3+
link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender
4+
level: error
5+
ignorecase: true
6+
tokens:
7+
- he/she
8+
- s/he
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
extends: substitution
2+
message: "Consider using '%s' instead of '%s'."
3+
ignorecase: true
4+
level: error
5+
action:
6+
name: replace
7+
swap:
8+
(?:alumna|alumnus): graduate
9+
(?:alumnae|alumni): graduates
10+
air(?:m[ae]n|wom[ae]n): pilot(s)
11+
anchor(?:m[ae]n|wom[ae]n): anchor(s)
12+
authoress: author
13+
camera(?:m[ae]n|wom[ae]n): camera operator(s)
14+
door(?:m[ae]|wom[ae]n): concierge(s)
15+
draft(?:m[ae]n|wom[ae]n): drafter(s)
16+
fire(?:m[ae]n|wom[ae]n): firefighter(s)
17+
fisher(?:m[ae]n|wom[ae]n): fisher(s)
18+
fresh(?:m[ae]n|wom[ae]n): first-year student(s)
19+
garbage(?:m[ae]n|wom[ae]n): waste collector(s)
20+
lady lawyer: lawyer
21+
ladylike: courteous
22+
mail(?:m[ae]n|wom[ae]n): mail carriers
23+
man and wife: husband and wife
24+
man enough: strong enough
25+
mankind: human kind
26+
manmade: manufactured
27+
manpower: personnel
28+
middle(?:m[ae]n|wom[ae]n): intermediary
29+
news(?:m[ae]n|wom[ae]n): journalist(s)
30+
ombuds(?:man|woman): ombuds
31+
oneupmanship: upstaging
32+
poetess: poet
33+
police(?:m[ae]n|wom[ae]n): police officer(s)
34+
repair(?:m[ae]n|wom[ae]n): technician(s)
35+
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
36+
service(?:m[ae]n|wom[ae]n): soldier(s)
37+
steward(?:ess)?: flight attendant
38+
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
39+
waitress: waiter
40+
woman doctor: doctor
41+
woman scientist[s]?: scientist(s)
42+
work(?:m[ae]n|wom[ae]n): worker(s)
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
extends: existence
2+
message: "For a general audience, use 'address' rather than 'URL'."
3+
link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
4+
level: warning
5+
action:
6+
name: replace
7+
params:
8+
- URL
9+
- address
10+
tokens:
11+
- URL
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
extends: existence
2+
message: "Use a numeral plus the units."
3+
link: https://docs.microsoft.com/en-us/style-guide/numbers
4+
nonword: true
5+
level: error
6+
tokens:
7+
- '\b[a-zA-z]+\spercent\b'

ThirdPartyNotices.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ see the [LICENSE][05] file, and grant you a license to any code in the repositor
88
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the
99
documentation may be either trademarks or registered trademarks of Microsoft in the United States
1010
and/or other countries. The licenses for this project do not grant you rights to use any Microsoft
11-
names, logos, or trademarks. You can find Microsoft general trademark guidelines at [Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks).
11+
names, logos, or trademarks. You can find Microsoft general trademark guidelines at
12+
[Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks).
1213

1314
For privacy information, see [privacy at Microsoft](https://privacy.microsoft.com/en-us/).
1415

0 commit comments

Comments
 (0)