Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grammatical issue in README: lack of parallelism #10761

Open
dellch opened this issue Dec 18, 2024 · 1 comment
Open

Grammatical issue in README: lack of parallelism #10761

dellch opened this issue Dec 18, 2024 · 1 comment

Comments

@dellch
Copy link

dellch commented Dec 18, 2024

Overview

The first sentence in the README under the "VSTest" heading lacks parallelism, which impacts clarity and grammatical correctness.

Current sentence

The Visual Studio Test Platform is an open and extensible test platform that enables running tests, collect diagnostics data and report results.

(emphasis added)

Problem

The list of actions (verbs)—"running," "collect," and "report"—does not follow a consistent structure.

Proposal

The Visual Studio Test Platform is an open and extensible test platform that runs tests, collects diagnostics data, and reports results.

Following recommendations from Microsoft's Style Guide, this:

Note: This proposal also includes the Oxford comma, which is consistent with the next sentence in the README, usage in SECURITY.md, and Microsoft's Style Guide (see also their top 10 tips for style and voice).

@nohwnd
Copy link
Member

nohwnd commented Jan 6, 2025

so what is your proposal to change? can you PR it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants