mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-08 20:27:36 +02:00

Files

Gordon Lam 0899961e56 Docs: consolidate instructions and fix prompt frontmatter (#44610 )

Title: Docs: consolidate Copilot instructions and prompt metadata

## Summary
- Consolidated AI guidance into a root AGENTS.md and new
`.github/instructions` files, removing older per-folder instructions.
- Scoped instruction files for pipelines, common libraries,
runner/settings UI, prompts, and simplified
`.github/copilot-instructions.md` to point to the sources of truth.
- Fixed prompt frontmatter (YAML markers, quoted fields, headings)
across built-in prompt files.
- Most instructions.md is from https://github.com/github/awesome-copilot

## Testing
- Not run (documentation/instructions-only change)

2026-01-08 20:04:33 +08:00

2.7 KiB

Raw Blame History

agent, model, description

agent	model	description
agent	GPT-5.1-Codex-Max	Execute the fix for a GitHub issue using the previously generated implementation plan

Fix GitHub Issue

Dependencies

Source review prompt (for generating the implementation plan if missing):

.github/prompts/review-issue.prompt.md

Required plan file (single source of truth):

Generated Files/issueReview/{{issue_number}}/implementation-plan.md

Dependency Handling

If implementation-plan.md exists → proceed.
If missing → run the review prompt:
- Invoke: .github/prompts/review-issue.prompt.md
- Pass: issue_number={{issue_number}}
- Then re-check for implementation-plan.md.
If still missing → stop and generate:
- Generated Files/issueFix/{{issue_number}}/manual-steps.md containing: “implementation-plan.md not found; please run .github/prompts/review-issue.prompt.md for #{{issue_number}}.”

GOAL

For #{{issue_number}}:

Use implementation-plan.md as the single authority.
Apply code and test changes directly in the repository.
Produce a PR-ready description.

OUTPUT FILES

Generated Files/issueFix/{{issue_number}}/pr-description.md
Generated Files/issueFix/{{issue_number}}/manual-steps.md # only if human interaction or external setup is required

EXECUTION RULES

Read implementation-plan.md and execute:
- Layers & Files → edit/create as listed
- Pattern Choices → follow repository conventions
- Fundamentals (perf, security, compatibility, accessibility)
- Logging & Exceptions
- Telemetry (only if explicitly included in the plan)
- Risks & Mitigations
- Tests to Add
Locate affected files via rg or git grep.
Add/update tests to enforce the fixed behavior.
If any ambiguity exists, add: // TODO(Human input needed):
Verify locally: build & tests run successfully.

pr-description.md should include:

Title: Fix: <short summary> (#{{issue_number}})
What changed and why the fix works
Files or modules touched
Risks & mitigations (implemented)
Tests added/updated and how to run them
Telemetry behavior (if applicable)
Validation / reproduction steps
Closes #{{issue_number}}

manual-steps.md (only if needed)

List required human actions: secrets, config, approvals, missing info, or code comments requiring human decisions.

IMPORTANT

Apply code and tests directly; do not produce patch files.
Follow implementation-plan.md as the source of truth.
Insert comments for human review where a decision or input is required.
Use repository conventions and deterministic, minimal changes.

FINALIZE

Write pr-description.md
Write manual-steps.md only if needed
Print concise success message or note items requiring human interaction

2.7 KiB Raw Blame History