Skip to content

Commit dbf073a

Browse files
authored
Revise AI issue template for clarity and guidance
Updated the issue template to enhance guidance for AI-augmented submissions and clarified the review process.
1 parent a4eaa96 commit dbf073a

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed
Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
1-
---
2-
name: 🐛 / 💡 Issue (with AI‑Augmented check)
3-
about: Report a bug or suggest a feature, with a prompt‑agent review before submitting
4-
---
5-
6-
# Augmented Intelligence (AI) Welcomed
71

8-
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.
9-
10-
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:
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:
113

124
> "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."
135
14-
Please attach the output of that model's review to your Issue or PR.
6+
(Optional) Please then attach both the prompt and the model's review to the bottom of this template under "Augmented Intelligence Review".
157

168
---
179

@@ -21,18 +13,18 @@ Please attach the output of that model's review to your Issue or PR.
2113
*A short, descriptive title*
2214

2315
**What happened / What you expected**:
16+
*Please provide plenty of text*
2417

2518
**Steps to reproduce** (for bugs):
2619
1.
2720
2.
2821
3.
2922

3023
**Suggested solution / feature description**:
24+
*Please ensure that they align with the stated goals and non-goals of the project*
3125

3226
**Additional context / logs / screenshots**:
27+
*screenshots and traces last, please ensure the details above work for anyone, and use this section for your specifics.
3328

34-
**Environment:**
35-
- Version:
36-
- OS / Platform:
37-
- Dependencies:
38-
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*

0 commit comments

Comments
 (0)