From 8a737709fc03a29db5adc99850a02eff88f5f11c Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Sat, 8 Aug 2026 22:54:10 +0100 Subject: [PATCH] Add agent guidance for issues and PRs Add a root AGENTS.md so agents that do not read Copilot-specific instructions still get repository guidance before filing issues or opening pull requests. Mirror the issue-template and pull-request expectations in .github/copilot-instructions.md so Copilot-backed agents also avoid blank issue submissions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 9 +++++++++ AGENTS.md | 22 ++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 8a7eb59..3b4198a 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -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. diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..ab3ac44 --- /dev/null +++ b/AGENTS.md @@ -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. +3. For bugs, include the same information requested by the Bug Report form: brief description, steps to reproduce, expected behavior, actual behavior, and environment. +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. +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. + +## 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. +3. Include or update tests and documentation when the change affects UI behavior, configuration parsing, command behavior, or user guidance. +4. Summarize validation performed, or explain why validation was not run.