Skip to content

Fix verb tense consistency in README setup instructions - #200

Merged
Chris-Wolfgang merged 4 commits into
Chris-Wolfgang-patch-2from
copilot/sub-pr-195-again
Feb 16, 2026
Merged

Fix verb tense consistency in README setup instructions#200
Chris-Wolfgang merged 4 commits into
Chris-Wolfgang-patch-2from
copilot/sub-pr-195-again

Conversation

Copilot AI commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

Description

Corrects subject-verb agreement and parallel structure in Quick Start section where bullet points describe automated setup script actions.

Type of change

  • Documentation update

How Has This Been Tested?

  • Visual inspection of README.md changes
  • Automated code review (no issues found)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Screenshots (if applicable)

Before:

- The script will ask you for required values and read other details from your git configuration and repository,
- Replace all placeholders with your project information,
- Create a branch, commit the changes and push it to your repository
- Create a pull request for you to review and merge if approved

After:

- The script will ask you for required values and read other details from your git configuration and repository,
- Replaces all placeholders with your project information,
- Creates a branch, commits the changes and pushes it to your repository
- Creates a pull request for you to review and merge if approved

Additional context

Addresses feedback from PR #195 review comment #2810358217. All bullet points now use consistent third-person singular present tense to describe script behavior.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 16, 2026 01:53
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
@Chris-Wolfgang
Chris-Wolfgang marked this pull request as ready for review February 16, 2026 01:55
Copilot AI review requested due to automatic review settings February 16, 2026 01:55
@Chris-Wolfgang
Chris-Wolfgang merged commit 0f90eb5 into Chris-Wolfgang-patch-2 Feb 16, 2026
@Chris-Wolfgang
Chris-Wolfgang deleted the copilot/sub-pr-195-again branch February 16, 2026 01:55
Copilot AI changed the title [WIP] WIP Address feedback on setup instructions revisions in README Fix verb tense consistency in README setup instructions Feb 16, 2026
Copilot AI requested a review from Chris-Wolfgang February 16, 2026 01:55
Copilot stopped work on behalf of Chris-Wolfgang due to an error February 16, 2026 01:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This WIP pull request addresses grammar and consistency issues in the README.md file's setup instructions section. The changes update verb tenses in lines 32-34 from imperative mood to third-person singular present tense to create parallel structure in the bullet point list describing what the setup script does.

Changes:

  • Updated verb forms in lines 32-34 from "Replace", "Create", "Create" to "Replaces", "Creates", "Creates" for grammatical consistency

Comment thread README.md
Comment on lines +32 to +34
- Replaces all placeholders with your project information,
- Creates a branch, commits the changes and pushes it to your repository
- Creates a pull request for you to review and merge if approved

Copilot AI Feb 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical inconsistency: Line 31 (not shown in diff) uses future tense with "will" ("The script will ask you for required values and read other details..."), but these sub-bullets now use third-person singular present tense ("Replaces", "Creates").

Looking at similar patterns in the README:

  • Lines 199-208: "The scripts will:" followed by base form verbs (Prompt, Replace, Delete, Rename)
  • Lines 438-443: "The script will:" followed by base form verbs (Prompt, Check, Create, Configure)
  • Line 51-56: "The setup script automatically:" followed by present tense verbs (Replaces, Swaps, Sets up)

For consistency with the rest of the document, either:

  1. Change lines 32-34 to use base form verbs: "Replace", "Create", "Create" (matches lines 199-208, 438-443 pattern)
  2. OR change line 31 to "The script automatically:" to match the pattern at line 51, keeping the present tense verbs "Replaces", "Creates"

Option 1 is recommended as it maintains the existing line 31 structure.

Suggested change
- Replaces all placeholders with your project information,
- Creates a branch, commits the changes and pushes it to your repository
- Creates a pull request for you to review and merge if approved
- Replace all placeholders with your project information,
- Create a branch, commit the changes, and push it to your repository
- Create a pull request for you to review and merge if approved

Copilot uses AI. Check for mistakes.
Chris-Wolfgang added a commit that referenced this pull request May 29, 2026
…on wiring)

Brings the in-page version-switcher dropdown — validated end-to-end on
DateTime-Extensions (PR #200, merged 2026-05-27) — into the canonical
template so future template-sync runs fan it out to every downstream
repo unchanged.

Four files, all under docfx_project/ and .github/ — none protected:

- docfx_project/public/version-picker.js (new, ~160 lines)
  Browser-side picker. Fetches versions.json, builds a themed
  <select> in the DocFX modern header, navigates on change. Handles
  github.io / localhost / CNAME automatically; strips the gh-pages
  /<repo>/ prefix from navigation URLs when not on github.io;
  color-scheme: light dark + Bootstrap CSS vars for the OS-rendered
  popup so it's readable in both themes; skips the "latest" alias
  in the dropdown (redundant); falls back silently (no broken page)
  if versions.json is missing.

- docfx_project/docfx.json
  build.resource.files gains "public/**" and "versions.json" so the
  picker JS + stub get copied into _site/.
  globalMetadata._appFooter gains a 6-line inline bootstrap that
  computes the site root and lazy-loads /<repo>/public/version-picker.js
  into document.head. Inline (not external) because _appFooter is a
  plain string field, not a Liquid template — page-relative paths
  wouldn't resolve from nested pages like /api/Foo.html.

- docfx_project/versions.json (new, [])
  Empty stub for local builds. The docfx.yaml workflow generates the
  real list from v* tags at deploy time and overwrites it on
  gh-pages. The empty stub is fanout-safe: no per-repo paths leak.

- .github/version-picker-template.html
  Replaces the "Select a documentation version" landing page with an
  auto-redirect to /versions/latest/ — Microsoft-Docs-style UX. The
  in-page dropdown does the selection job; the root no longer needs
  a separate landing page. meta-refresh + JS setTimeout backup +
  <noscript> link cover every redirect failure mode. {{VERSION_LIST}}
  placeholder removed entirely — a missing pattern is a true no-op
  for PowerShell -replace.

Companion docs/DOCFX-VERSION-PICKER.md describing the implementation
will land in a follow-up docs PR; the present PR is the canonical-
config portion that fan-out to downstream repos depends on.

After this lands, template-drift-scan will surface every downstream
repo as drifted on these files. Use bulk-repo-pr to fan out.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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

Successfully merging this pull request may close these issues.

3 participants