diff --git a/.github/ISSUE_TEMPLATE/issue_with_ai.md b/.github/ISSUE_TEMPLATE/issue_with_ai.md new file mode 100644 index 0000000..20ca4b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_with_ai.md @@ -0,0 +1,30 @@ + +(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 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". + +--- + +## Describe the Issue or Feature Request + +**Title**: +*A short, descriptive title* + +**What happened / What you expected**: +*Please provide plenty of text* + +**Steps to reproduce** (for bugs): +1. +2. +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. + +**(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* diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..53906c9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ + +(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 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". + +--- +## 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 +- [ ] Update to use `CODING_STYLE_LLM.md` convensions +- [ ] Documentation updated if needed +- [ ] `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* +