search

errata-ai / Microsoft

A Vale-compatible implementation of the Microsoft Writing Style Guide.
https://github.com/errata-ai/vale
MIT License
85 stars 46 forks source link

Add the "A-Z word list and term collections" coverage file #31

Closed ShahradR closed 4 years ago

ShahradR commented 4 years ago

Sorry for the delay—this pull request is a follow-up on the discussion we had in errata-ai/Microsoft#15, and adds coverage information for the A-Z word list and term collections section of the Microsoft Style Guide!

I'm just starting with Vale, so if anything in this PR doesn't look right, just let me know!

Word format

I formatted the word list based on the Markdown file names in the microsoft-style-guide GitHub repository, but preserving the order shown in the table of contents.

Detailed rule information

For words with multiple rules, I wasn't quite sure how to handle it—I figured one file per word might be a bit unwieldy, so I thought we could set the coverage to false and list the files where partial rules are implemented as comments? It's more condensed, but on the other hand, the onus is on the developer to see what has been implemented, and decide whether coverage has been achieved or not. If you want this represented in any other way though, we can change that up!

Commits

All the commits are signed, but they're a bit piecemeal—I left them as-is to make the review easier (the last few commits are probably the most interesting ones), but we can squash them all into a single big commit, if you like!

jdkato commented 4 years ago

Thanks -- this is going to be very useful for tracking our progress. The formatting decisions you made also look reasonable to me.

ShahradR commented 4 years ago

Thanks! Glad this helps! 😄