mirror of https://github.com/microsoft/PowerToys.git synced 2026-02-23 19:49:43 +01:00

Files

Gordon Lam a246789719 docs(prompts): sync commit/pr guidance and Copilot settings (#44627 )

## Summary of the Pull Request
- Clarified the PR-summary prompt to prepend a PR title and to reuse the
Conventional Commit rules from
`.github/prompts/create-commit-title.prompt.md`.
- Expanded the commit-title prompt with clearer purpose, inputs, and
Conventional Commit guidance.
- Added workspace Copilot chat settings in `.vscode/settings.json` to
point review/commit/PR generation at the repo prompt files.

e.g. for commit tile generation:
<img width="562" height="376" alt="image"
src="https://github.com/user-attachments/assets/ca11d117-e4ad-4d1e-abb7-2b4600690f45"
/>


## PR Checklist
- [ ] Closes: N/A
- [ ] Communication: N/A (prompt/settings maintenance)
- [ ] Tests: Not run (prompt/settings-only change)

## Detailed Description of the Pull Request / Additional comments
- The PR-summary workflow now directs PR title generation to the
existing commit-title prompt instead of duplicating rules, and places
the title above the filled template.
- The commit-title prompt now spells out required diff command, decision
steps, and Conventional Commit examples.
- VS Code Copilot chat settings ensure review, commit, and PR
description generation use the repository prompts consistently.

## Validation Steps Performed
- Not run (no product code changes)

2026-01-09 11:38:05 +08:00

2.1 KiB

Raw Blame History

agent, model, description

agent	model	description
agent	GPT-5.1-Codex-Max	Generate a PowerToys-ready pull request description from the local diff

Generate PR Summary

Goal: Produce a ready-to-paste PR title and description that follows PowerToys conventions by comparing the current branch against a user-selected target branch.

Repo guardrails:

Treat .github/pull_request_template.md as the single source of truth; load it at runtime instead of embedding hardcoded content in this prompt.
Preserve section order from the template but only surface checklist lines that are relevant for the detected changes, filling them with [x]/[ ] as appropriate.
Cite touched paths with inline backticks, matching the guidance in .github/copilot-instructions.md.
Call out test coverage explicitly: list automated tests run (unit/UI) or state why they are not applicable.

Workflow:

Determine the target branch from user context; default to main when no branch is supplied.
Run git status --short once to surface uncommitted files that may influence the summary.
Run git diff <target-branch>...HEAD a single time to review the detailed changes. Only when confidence stays low dig deeper with focused calls such as git diff <target-branch>...HEAD -- <path>.
From the diff, capture impacted areas, key file changes, behavioral risks, migrations, and noteworthy edge cases.
Confirm validation: list tests executed with results or state why tests were skipped in line with repo guidance.
Load .github/pull_request_template.md, mirror its section order, and populate it with the gathered facts. Include only relevant checklist entries, marking them [x]/[ ] and noting any intentional omissions as "N/A".
Present the filled template inside a fenced ```markdown code block with no extra commentary so it is ready to paste into a PR, clearly flagging any placeholders that still need user input.
Prepend the PR title above the filled template, applying the Conventional Commit type/scope rules from .github/prompts/create-commit-title.prompt.md; pick the dominant component from the diff and keep the title concise and imperative.

2.1 KiB Raw Blame History

Generate PR Summary

2.1 KiB

Raw Blame History