mirror of
https://github.com/microsoft/PowerToys.git
synced 2025-12-16 03:37:59 +01:00
fc1307418e
## Summary of the Pull Request - Added new Copilot agent prompts in `.github/prompts/create-commit-title.prompt.md`, `.github/prompts/create-pr.prompt.md`, and `.github/prompts/fix-spelling.prompt.md` to streamline contributor workflows. - Refreshed `.github/copilot-instructions.md` with front matter and clarified build/test guidance. And added a new section titled `Language Style Rules` to help reduce style issues in auto-generated code. ## Screenshot a. For the new prompts, in VSCode, just type "/" and its name <img width="477" height="124" alt="image" src="https://github.com/user-attachments/assets/37c7330d-6fdc-45b4-9030-95920920c964" /> <img width="446" height="105" alt="image" src="https://github.com/user-attachments/assets/55d3bb49-46cc-4441-9fb5-fed3a22983d9" /> b. All the spelling check problem, PR description, Commit title, are generated and fixed by above prompts as demonstration (Except this section) ## PR Checklist - [x] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [x] **Tests:** N/A on doc updates. - [x] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx (N/A) ## Detailed Description of the Pull Request / Additional comments - Introduced prompt definitions so local tooling can generate commit titles, PR descriptions, and resolve spell-check alerts using consistent instructions. - Added GitHub CLI prerequisites inside `.github/prompts/fix-spelling.prompt.md` to ensure `gh` commands succeed for new contributors. - Converted `.github/copilot-instructions.md` to YAML-front-matter format while aligning headings and terminology with current contributor guidance. ## Validation Steps Performed - No automated tests were run; changes are documentation and configuration only.
check-spelling/check-spelling configuration
| File | Purpose | Format | Info |
|---|---|---|---|
| allow.txt | Add words to the dictionary | one word per line (only letters and 's allowed) |
allow |
| reject.txt | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | reject |
| excludes.txt | Files to ignore entirely | perl regular expression | excludes |
| only.txt | Only check matching files (applied after excludes) | perl regular expression | only |
| patterns.txt | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | patterns |
| candidate.patterns | Patterns that might be worth adding to patterns.txt | perl regular expression with optional comment block introductions (all matches will be suggested) | candidates |
| line_forbidden.patterns | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | patterns |
| expect.txt | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | expect |
| advice.md | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | advice |
Note: you can replace any of these files with a directory by the same name (minus the suffix) and then include multiple files inside that directory (with that suffix) to merge multiple files together.