From a4eaa963ec2d86b3cd67b20ec7a970ed1d95482a Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Mon, 22 Sep 2025 13:32:29 +0000 Subject: [PATCH 1/4] Add issue and PR templates with AI review prompt Co-authored-by: simbo1905 --- .github/ISSUE_TEMPLATE/issue_with_ai.md | 38 +++++++++++++++++++++++++ .github/pull_request_template.md | 35 +++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue_with_ai.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/issue_with_ai.md b/.github/ISSUE_TEMPLATE/issue_with_ai.md new file mode 100644 index 0000000..37f47e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_with_ai.md @@ -0,0 +1,38 @@ +--- +name: 🐛 / 💡 Issue (with AI‑Augmented check) +about: Report a bug or suggest a feature, with a prompt‑agent review before submitting +--- + +# Augmented Intelligence (AI) Welcomed + +AI as **Augmented Intelligence** is most welcome here. Contributions that enhance *human + agent collaboration* are encouraged. If you want to suggest new agent‑workflows, prompt patterns, or improvements in tooling / validation / introspection, please submit amendments to **AGENTS.md** via standalone PRs. Your ideas make the difference. + +When submitting Issues or PRs, please use a "deep research" tool to sanity check your proposal. Then before submission run your draft through a strong model with a prompt such as: + +> "Please review the AGENTS.md and README.md along with this draft PR/Issue and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." + +Please attach the output of that model's review to your Issue or PR. + +--- + +## Describe the Issue or Feature Request + +**Title**: +*A short, descriptive title* + +**What happened / What you expected**: + +**Steps to reproduce** (for bugs): +1. +2. +3. + +**Suggested solution / feature description**: + +**Additional context / logs / screenshots**: + +**Environment:** +- Version: +- OS / Platform: +- Dependencies: + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..152fd1e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +--- +name: 🔀 Pull Request (with AI‑Augmented check) +about: Propose changes, including AI‑agent / tooling transparency and review +--- + +# Augmented Intelligence (AI) Welcomed + +AI as **Augmented Intelligence** is most welcome here. Contributions that enhance *human + agent collaboration* are encouraged. If you want to suggest new agent‑workflows, prompt patterns, or improvements in tooling / validation / introspection, please submit amendments to **AGENTS.md** via standalone PRs. Your ideas make the difference. + +When submitting Issues or PRs, please use a "deep research" tool to sanity check your proposal. Then before submission run your draft through a strong model with a prompt such as: + +> "Please review the AGENTS.md and README.md along with this draft PR/Issue and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." + +Please attach the output of that model's review to your PR. + +--- + +## What changed + +- A summary of the changes in this PR + +## Why this change is needed + +- Motivation / context + +## How were these changes tested + +- Test plan / manual testing / automated tests etc. + +## Checklist + +- [ ] Code builds / passes tests +- [ ] New tests added if needed +- [ ] Documentation updated if needed +- [ ] `AGENTS.md` updated if you are adding or modifying agent workflows or prompt templates From dbf073a448a15b09d0a25425e6d3fee741d30cd5 Mon Sep 17 00:00:00 2001 From: Simon Massey <322608+simbo1905@users.noreply.github.com> Date: Mon, 22 Sep 2025 14:47:29 +0100 Subject: [PATCH 2/4] Revise AI issue template for clarity and guidance Updated the issue template to enhance guidance for AI-augmented submissions and clarified the review process. --- .github/ISSUE_TEMPLATE/issue_with_ai.md | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue_with_ai.md b/.github/ISSUE_TEMPLATE/issue_with_ai.md index 37f47e6..505a951 100644 --- a/.github/ISSUE_TEMPLATE/issue_with_ai.md +++ b/.github/ISSUE_TEMPLATE/issue_with_ai.md @@ -1,17 +1,9 @@ ---- -name: 🐛 / 💡 Issue (with AI‑Augmented check) -about: Report a bug or suggest a feature, with a prompt‑agent review before submitting ---- - -# Augmented Intelligence (AI) Welcomed -AI as **Augmented Intelligence** is most welcome here. Contributions that enhance *human + agent collaboration* are encouraged. If you want to suggest new agent‑workflows, prompt patterns, or improvements in tooling / validation / introspection, please submit amendments to **AGENTS.md** via standalone PRs. Your ideas make the difference. - -When submitting Issues or PRs, please use a "deep research" tool to sanity check your proposal. Then before submission run your draft through a strong model with a prompt such as: +(Optional) When submitting an Issue, please consider using a "deep research" tool to sanity check your proposal. Then **before** submission, run your draft through a strong model with a prompt such as: > "Please review the AGENTS.md and README.md along with this draft PR/Issue and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." -Please attach the output of that model's review to your Issue or PR. +(Optional) Please then attach both the prompt and the model's review to the bottom of this template under "Augmented Intelligence Review". --- @@ -21,6 +13,7 @@ Please attach the output of that model's review to your Issue or PR. *A short, descriptive title* **What happened / What you expected**: +*Please provide plenty of text* **Steps to reproduce** (for bugs): 1. @@ -28,11 +21,10 @@ Please attach the output of that model's review to your Issue or PR. 3. **Suggested solution / feature description**: +*Please ensure that they align with the stated goals and non-goals of the project* **Additional context / logs / screenshots**: +*screenshots and traces last, please ensure the details above work for anyone, and use this section for your specifics. -**Environment:** -- Version: -- OS / Platform: -- Dependencies: - +**(Optional) Augmented Intelligence Review**: +*Both prompt and model out, asking a strong model to double-check your submission, from the perspective of a maintainer of this repo* From 33d6dedb9ca1a97086ea3199393fba0fba5eb522 Mon Sep 17 00:00:00 2001 From: Simon Massey <322608+simbo1905@users.noreply.github.com> Date: Mon, 22 Sep 2025 14:52:01 +0100 Subject: [PATCH 3/4] Revise pull request template for clarity and AI guidance Updated the pull request template to streamline instructions and clarify the use of AI in reviews. --- .github/pull_request_template.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 152fd1e..53906c9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,11 @@ ---- -name: 🔀 Pull Request (with AI‑Augmented check) -about: Propose changes, including AI‑agent / tooling transparency and review ---- - -# Augmented Intelligence (AI) Welcomed - -AI as **Augmented Intelligence** is most welcome here. Contributions that enhance *human + agent collaboration* are encouraged. If you want to suggest new agent‑workflows, prompt patterns, or improvements in tooling / validation / introspection, please submit amendments to **AGENTS.md** via standalone PRs. Your ideas make the difference. -When submitting Issues or PRs, please use a "deep research" tool to sanity check your proposal. Then before submission run your draft through a strong model with a prompt such as: +(Optional) When submitting an PR, please consider using a "deep research" tool to sanity check your proposal. Then **before** submission, run your draft through a strong model with a prompt such as: -> "Please review the AGENTS.md and README.md along with this draft PR/Issue and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." +> "Please review the AGENTS.md and README.md along with this draft PR and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." -Please attach the output of that model's review to your PR. +(Optional) Please then attach both the prompt and the model's review to the bottom of this template under "Augmented Intelligence Review". --- - ## What changed - A summary of the changes in this PR @@ -30,6 +21,11 @@ Please attach the output of that model's review to your PR. ## Checklist - [ ] Code builds / passes tests -- [ ] New tests added if needed +- [ ] New tests added if needed +- [ ] Update to use `CODING_STYLE_LLM.md` convensions - [ ] Documentation updated if needed -- [ ] `AGENTS.md` updated if you are adding or modifying agent workflows or prompt templates +- [ ] `AGENTS.md` updated if appropriate + +**(Optional) Augmented Intelligence Review**: +*Both prompt and model out, asking a strong model to double-check your submission, from the perspective of a maintainer of this repo* + From 3081bd6e67c30ab0c3a43da938a812f72ec09ec6 Mon Sep 17 00:00:00 2001 From: Simon Massey <322608+simbo1905@users.noreply.github.com> Date: Mon, 22 Sep 2025 14:52:18 +0100 Subject: [PATCH 4/4] Clarify draft type in issue template Updated wording in the issue template to specify 'draft Issue' instead of 'draft PR/Issue'. --- .github/ISSUE_TEMPLATE/issue_with_ai.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/issue_with_ai.md b/.github/ISSUE_TEMPLATE/issue_with_ai.md index 505a951..20ca4b1 100644 --- a/.github/ISSUE_TEMPLATE/issue_with_ai.md +++ b/.github/ISSUE_TEMPLATE/issue_with_ai.md @@ -1,7 +1,7 @@ (Optional) When submitting an Issue, please consider using a "deep research" tool to sanity check your proposal. Then **before** submission, run your draft through a strong model with a prompt such as: -> "Please review the AGENTS.md and README.md along with this draft PR/Issue and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." +> "Please review the AGENTS.md and README.md along with this draft Issue and check that it does not have any gaps — why it might be insufficient, incomplete, lacking a concrete example, duplicating prior issues or PRs, or not be aligned with the project goals or non‑goals." (Optional) Please then attach both the prompt and the model's review to the bottom of this template under "Augmented Intelligence Review".