https://github.com/errata-ai/microsoft

A Vale-compatible implementation of the Microsoft Writing Style Guide.
https://github.com/errata-ai/microsoft

vale vale-linter-style vale-style

Last synced: 9 days ago
JSON representation

A Vale-compatible implementation of the Microsoft Writing Style Guide.

• Host: GitHub
• URL: https://github.com/errata-ai/microsoft
• Owner: errata-ai
• License: mit
• Created: 2018-03-05T22:19:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-04-11T04:49:05.000Z (3 months ago)
• Last Synced: 2025-06-19T00:04:06.905Z (9 days ago)
• Topics: vale, vale-linter-style, vale-style
• Language: Gherkin
• Homepage: https://github.com/errata-ai/vale
• Size: 247 KB
• Stars: 98
• Watchers: 14
• Forks: 46
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Microsoft

> **NOTE**: This project is neither maintained nor endorsed by Microsoft.

This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) implementation of the [*Microsoft Writing Style Guide*](https://docs.microsoft.com/en-us/style-guide/welcome/) ([LICENSE](https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/LICENSE)).

## Getting Started

To get started, add the package to your configuration file (as shown below) and then run `vale sync`.

```ini

StylesPath = styles

MinAlertLevel = suggestion

Packages = Microsoft

[*]

BasedOnStyles = Vale, Microsoft

```

See [Packages](https://vale.sh/hub/microsoft/) for more information.

## Repository Structure



  
/Microsoft

  
The YAML-based rule implementations that make up our style.


  
/fixtures

  
The individual unit tests. Each directory should be named after a rule found in /Microsoft and include its own .vale.ini file that isolates its target rule.


  
/features

  
The Cucumber Step Definitions we use to test our fixtures. Essentially, we use the aruba framework to test Vale's output after running it on each of our fixture directories.



## Extension Points

|   Check    |                    Implementations                   |

|:------------:|:-------------------------------------------------:|

| [`existence`](https://errata-ai.github.io/vale/styles/#existence)  | [`Accessibility.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Accessibility.yml), [`Adverbs.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Adverbs.yml), [`AMPM.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/AMPM.yml), [`Auto.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Auto.yml), [`Avoid.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Avoid.yml), [`Dashes.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Dashes.yml), [`DateFormat.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/DateFormat.yml), [`Ellipses.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Ellipses.yml), [`FirstPerson.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/FirstPerson.yml), [`HeadingColons.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/HeadingColons.yml), [`HeadingPunctuation.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/HeadingPunctuation.yml), [`Hyphens.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Hyphens.yml), [`OxfordComma.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/OxfordComma.yml), [`Passive.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Passive.yml), [`Quotes.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Quotes.yml) |

| [`substitution`](https://errata-ai.github.io/vale/styles/#substitution)  | [`Backend.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Backend.yml) (POS tags), [`ComplexWords.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/ComplexWords.yml), [`Contractions.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Contractions.yml), [`Foreign.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Foreign.yml), [`Terms.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Terms.yml) |

| [`occurrence`](https://errata-ai.github.io/vale/styles/#occurrence)  | N/A |

| [`repetition`](https://errata-ai.github.io/vale/styles/#repetition)  | N/A |

| [`consistency`](https://errata-ai.github.io/vale/styles/#consistency)| N/A |

| [`capitalization`](https://errata-ai.github.io/vale/styles/#capitalization)  | [`Headings.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Headings.yml) |

| [`readability`](https://errata-ai.github.io/vale/styles/#readability)  | N/A |

| [`conditional`](https://errata-ai.github.io/vale/styles/#conditional)  | [`Acronyms.yml`](https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Acronyms.yml) |

| [`spelling`](https://errata-ai.github.io/vale/styles/#spelling)  | N/A |