mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-08-29 10:09:43 +02:00
70ff4013b9
Adds a reference to the WinGet Manifest Keyboard Shortcuts schema spec in `.github/copilot-instructions.md` so AI agents know where to find the correct field definitions, file naming conventions, and the `+` prefix rule when creating or editing Shortcut Guide V2 manifest files. ## Summary of the Pull Request Adds a new `## Shortcut Guide V2 Manifests` section to `.github/copilot-instructions.md` linking to [`doc/specs/WinGet Manifest Keyboard Shortcuts schema.md`](../doc/specs/WinGet%20Manifest%20Keyboard%20Shortcuts%20schema.md). This ensures agents authoring new manifest files follow the correct schema and naming scheme (e.g., `<PackageId>.<locale>.yml`, `+` prefix for apps without a WinGet package). ## PR Checklist - [ ] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [ ] **Tests:** Added/updated and all pass - [ ] **Localization:** All end-user-facing strings can be localized - [ ] **Dev docs:** Added/updated - [ ] **New binaries:** Added on the required places - [ ] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [ ] **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 ## Detailed Description of the Pull Request / Additional comments `.github/copilot-instructions.md` gains a dedicated section: ```markdown ## Shortcut Guide V2 Manifests When creating or editing Shortcut Guide keyboard shortcut manifest files, follow the schema and naming conventions in the spec: - [WinGet Manifest Keyboard Shortcuts schema](<../doc/specs/WinGet Manifest Keyboard Shortcuts schema.md>) – manifest file format, field definitions, file naming, and the `+` prefix convention for apps without a WinGet package ``` No production code changes. ## Validation Steps Performed - Verified the relative link resolves to the correct spec file in the repository. - Confirmed the section is correctly placed before "Detailed Documentation". --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
---
|
||
description: 'PowerToys AI contributor guidance'
|
||
---
|
||
|
||
# PowerToys – Copilot Instructions
|
||
|
||
Concise guidance for AI contributions. For complete details, see [AGENTS.md](../AGENTS.md).
|
||
|
||
## Key Rules
|
||
|
||
- Atomic PRs: one logical change, no drive-by refactors
|
||
- Add tests when changing behavior
|
||
- Keep hot paths quiet (no logging in hooks/tight loops)
|
||
|
||
## Style Enforcement
|
||
|
||
- C#: `src/.editorconfig`, StyleCop.Analyzers
|
||
- C++: `src/.clang-format`
|
||
- XAML: XamlStyler
|
||
|
||
## When to Ask for Clarification
|
||
|
||
- Ambiguous spec after scanning docs
|
||
- Cross-module impact unclear
|
||
- Security, elevation, or installer changes
|
||
|
||
## Component-Specific Instructions
|
||
|
||
These are auto-applied based on file location:
|
||
- [Runner & Settings UI](.github/instructions/runner-settings-ui.instructions.md)
|
||
- [Common Libraries](.github/instructions/common-libraries.instructions.md)
|
||
|
||
## Shortcut Guide V2 Manifests
|
||
|
||
When creating or editing Shortcut Guide keyboard shortcut manifest files, follow the schema and naming conventions in the spec:
|
||
|
||
- [WinGet Manifest Keyboard Shortcuts schema](<../doc/specs/WinGet Manifest Keyboard Shortcuts schema.md>) – manifest file format, field definitions, file naming, and the `+` prefix convention for apps without a WinGet package
|
||
|
||
## Detailed Documentation
|
||
|
||
- [Architecture](../doc/devdocs/core/architecture.md)
|
||
- [Coding Style](../doc/devdocs/development/style.md) |