Skip to content

Add agent guidance for issues and PRs #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AmirMS (AmelBawa-msft) merged 1 commit into from
Aug 10, 2026
Merged

Add agent guidance for issues and PRs #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ Run tests via Visual Studio Test Explorer against `WinGetStudio.Tests.MSTest`, o
- This project is **experimental** — expect API/format churn; check `docs/changelog.md` before assuming stability of a given surface.
- CI runs via Azure Pipelines.

## Issues and Pull Requests

- Before filing an issue, search existing open and closed issues for duplicates.
- Use the GitHub issue forms in `.github/ISSUE_TEMPLATE/`; do not file a blank issue unless a maintainer explicitly asks for one.
- Bug reports should include the form fields for brief description, steps to reproduce, expected behavior, actual behavior, and environment.
- Feature requests should include the form fields for feature or enhancement description and proposed technical implementation details when known.
- Keep issue bodies concise and evidence-based. Do not paste large speculative patches into issue bodies; open a pull request or link a branch when code is available.
- Before opening a pull request, review `CONTRIBUTING.md`, follow the PR template, keep the change focused, and summarize validation performed.

## Privacy & Telemetry

The application logs basic diagnostic telemetry. See `docs/` and `PRIVACY.md` for details on what is collected.
22 changes: 22 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Agent instructions

Follow `.github/copilot-instructions.md` for repository-specific development guidance.

## Issues

Before filing a GitHub issue in this repository:

1. Search existing open and closed issues for duplicates.
2. Use the GitHub issue forms in `.github/ISSUE_TEMPLATE/`; do not file a blank issue unless a maintainer explicitly asks for one.

Check failure on line 10 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Ordered list item prefix 

AGENTS.md:10:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md

Check failure on line 10 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Line length 

AGENTS.md:10:101 MD013/line-length Line length [Expected: 100; Actual: 130] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
3. For bugs, include the same information requested by the Bug Report form: brief description, steps to reproduce, expected behavior, actual behavior, and environment.

Check failure on line 11 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Ordered list item prefix 

AGENTS.md:11:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md

Check failure on line 11 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Line length 

AGENTS.md:11:101 MD013/line-length Line length [Expected: 100; Actual: 167] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
4. For feature requests, include the same information requested by the Feature Request form: description of the new feature or enhancement and proposed technical implementation details when known.

Check failure on line 12 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Ordered list item prefix 

AGENTS.md:12:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md

Check failure on line 12 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Line length 

AGENTS.md:12:101 MD013/line-length Line length [Expected: 100; Actual: 196] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
5. Keep issue bodies concise and evidence-based. Do not paste large speculative patches into issue bodies; open a pull request or link a branch when code is available.

Check failure on line 13 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Ordered list item prefix 

AGENTS.md:13:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md

Check failure on line 13 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Line length 

AGENTS.md:13:101 MD013/line-length Line length [Expected: 100; Actual: 167] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

## Pull requests

Before opening a pull request:

1. Review `CONTRIBUTING.md` and follow the repository PR template.
2. Keep each PR focused on one logical change.

Check failure on line 20 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Ordered list item prefix 

AGENTS.md:20:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md
3. Include or update tests and documentation when the change affects UI behavior, configuration parsing, command behavior, or user guidance.

Check failure on line 21 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Check Markdown linting

Line length 

AGENTS.md:21:101 MD013/line-length Line length [Expected: 100; Actual: 140] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
4. Summarize validation performed, or explain why validation was not run.
Loading