Skip to content

Commit 33d6ded

Browse files
authored
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.
1 parent dbf073a commit 33d6ded

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

.github/pull_request_template.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
1-
---
2-
name: 🔀 Pull Request (with AI‑Augmented check)
3-
about: Propose changes, including AI‑agent / tooling transparency and review
4-
---
5-
6-
# Augmented Intelligence (AI) Welcomed
7-
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.
91

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 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:
113

12-
> "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."
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."
135
14-
Please attach the output of that model's review to your 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
---
17-
189
## What changed
1910

2011
- A summary of the changes in this PR
@@ -30,6 +21,11 @@ Please attach the output of that model's review to your PR.
3021
## Checklist
3122

3223
- [ ] Code builds / passes tests
33-
- [ ] New tests added if needed
24+
- [ ] New tests added if needed
25+
- [ ] Update to use `CODING_STYLE_LLM.md` convensions
3426
- [ ] Documentation updated if needed
35-
- [ ] `AGENTS.md` updated if you are adding or modifying agent workflows or prompt templates
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)