Skip to content

Commit 5776ac5

Browse files
authored
Add ai augmented issue and pr templates (#52)
* Add issue and PR templates with AI review prompt Co-authored-by: simbo1905 <[email protected]> * Revise AI issue template for clarity and guidance Updated the issue template to enhance guidance for AI-augmented submissions and clarified the review process. * 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. * Clarify draft type in issue template Updated wording in the issue template to specify 'draft Issue' instead of 'draft PR/Issue'.
1 parent 77c1b0d commit 5776ac5

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
(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:
3+
4+
> "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."
5+
6+
(Optional) Please then attach both the prompt and the model's review to the bottom of this template under "Augmented Intelligence Review".
7+
8+
---
9+
10+
## Describe the Issue or Feature Request
11+
12+
**Title**:
13+
*A short, descriptive title*
14+
15+
**What happened / What you expected**:
16+
*Please provide plenty of text*
17+
18+
**Steps to reproduce** (for bugs):
19+
1.
20+
2.
21+
3.
22+
23+
**Suggested solution / feature description**:
24+
*Please ensure that they align with the stated goals and non-goals of the project*
25+
26+
**Additional context / logs / screenshots**:
27+
*screenshots and traces last, please ensure the details above work for anyone, and use this section for your specifics.
28+
29+
**(Optional) Augmented Intelligence Review**:
30+
*Both prompt and model out, asking a strong model to double-check your submission, from the perspective of a maintainer of this repo*

.github/pull_request_template.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
(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:
3+
4+
> "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."
5+
6+
(Optional) Please then attach both the prompt and the model's review to the bottom of this template under "Augmented Intelligence Review".
7+
8+
---
9+
## What changed
10+
11+
- A summary of the changes in this PR
12+
13+
## Why this change is needed
14+
15+
- Motivation / context
16+
17+
## How were these changes tested
18+
19+
- Test plan / manual testing / automated tests etc.
20+
21+
## Checklist
22+
23+
- [ ] Code builds / passes tests
24+
- [ ] New tests added if needed
25+
- [ ] Update to use `CODING_STYLE_LLM.md` convensions
26+
- [ ] Documentation updated if needed
27+
- [ ] `AGENTS.md` updated if appropriate
28+
29+
**(Optional) Augmented Intelligence Review**:
30+
*Both prompt and model out, asking a strong model to double-check your submission, from the perspective of a maintainer of this repo*
31+

0 commit comments

Comments
 (0)