Skip to content

Add Copilot instructions for writing specifications#6205

Merged
denelon merged 2 commits intomicrosoft:masterfrom
denelon:denelon/copilot-instructions-specs
May 4, 2026
Merged

Add Copilot instructions for writing specifications#6205
denelon merged 2 commits intomicrosoft:masterfrom
denelon:denelon/copilot-instructions-specs

Conversation

@denelon
Copy link
Copy Markdown
Collaborator

@denelon denelon commented May 4, 2026

📖 Description

Adds .github/instructions/specs.instructions.md for specification authoring guidance and updates .github/copilot-instructions.md to reference it. This was split from #6201 to keep the specification content separate from tooling guidance.

Created with GitHub Copilot assistance.

🔗 References

Resolves #6204

🔍 Validation

  • Reviewed the instruction content and the related Copilot instruction update.

✅ Checklist

📋 Issue Type

  • Bug fix
  • Feature
  • Task

Add specs.instructions.md with guidance for specification document
structure, front matter, deprecation paths, cross-repository schema
impact, settings/arguments, and CLI argument tables.

Update copilot-instructions.md to reference the new scoped instruction
file for the doc/specs/ directory.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@denelon denelon marked this pull request as ready for review May 4, 2026 03:36
@denelon denelon requested a review from a team as a code owner May 4, 2026 03:36
Comment thread .github/instructions/specs.instructions.md Outdated
Comment thread .github/instructions/specs.instructions.md Outdated
Comment thread .github/instructions/specs.instructions.md
Comment thread .github/instructions/specs.instructions.md
Comment thread .github/instructions/specs.instructions.md
Comment thread .github/instructions/specs.instructions.md Outdated
- Remove redundant scope line (frontmatter covers it)
- Update schema version example to 1.28.0 → 1.29.0
- Add winget-create to cross-repository impact section
- Add --no-vt interactivity mode documentation
- Change 'new words' to 'uncommon words' for spelling section

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Client behavior (CLI commands affected and how they behave)
- COM API surface changes (IDL definitions)
- PowerShell cmdlet changes (affected cmdlets, interactive vs. pipeline behavior, output objects)
- Settings changes (new or modified settings with JSON examples and interaction tables)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What about group policies?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I suspect most specs wouldn't have them.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I added a TODO with my robot

- **Interactive** (default) — Prompts are shown and user input is accepted.
- **`--no-vt`** — I/O stream is available but VT (virtual terminal) escape sequences are not processed. This is a layer between fully interactive and non-interactive — specs should consider whether features need special handling when VT is unavailable.
- **`--disable-interactivity`** — No prompts; operations proceed automatically.
- **`--silent`** — Implies non-interactive.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't this one about the installer, not about winget?

When proposing a replacement for an existing field or feature:

- Define a phased deprecation path (Introduction → Transition → Deprecation → Removal).
- Make timelines conditional on adoption telemetry, not fixed dates.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The timeline should also depend on the version of winget that ships out of the box with Windows.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good call out. Another TODO

@denelon denelon merged commit 233d138 into microsoft:master May 4, 2026
4 checks passed
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.

Add Copilot instructions for writing specifications

4 participants