Add DEEP framework AI usage guidance to issue and PR templates#46
Add DEEP framework AI usage guidance to issue and PR templates#46
Conversation
3a38bf4 to
31e2dad
Compare
31e2dad to
d44c2e8
Compare
.github/ISSUE_TEMPLATE/bug_issue.md
Outdated
| <!-- | ||
| AI DISCLOSURE: If this issue was written with AI assistance, add: | ||
| 🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖 | ||
| OPTIONAL - Delete if not needed. |
There was a problem hiding this comment.
In majority of cases it'll probably be needed. And if there's an expectation for people to pay attention, whether us or external contributors, I would probably just delete this line..Because optional = skip automatically for many :)
There was a problem hiding this comment.
And to allow for some exceptions, we could keep the previous phrasing?
If this issue was written with AI assistance, add:
There was a problem hiding this comment.
Fixed — removed the "OPTIONAL" line from all templates. The existing conditional phrasing ("If AI was used..." / "If AI was not used, delete the section below.") handles it.
There was a problem hiding this comment.
Sorry, my Claude CLI posted this before I could stop it - cheeky scamp! But yes, I think the phrasing that's there replaces the previous conditional.
| Edit - Digest and refine AI output rather than copy-pasting it. | ||
| Process sharing - Explain how you used the AI so others can learn. | ||
|
|
||
| Examples of good disclosures: |
Replace minimal AI disclosure comment in all 7 issue templates and add a new AI usage section to the PR template, embedding Learning Equality's DEEP guidelines (Disclose, Engage critically, Edit, Process sharing) with context-appropriate examples for each template type. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
d44c2e8 to
142da9f
Compare
Summary
Replace the brief AI disclosure comment in all issue templates and the PR template with detailed DEEP framework guidance (Disclose, Engage critically, Edit, Process sharing). Each template now includes examples of good AI usage disclosures and an optional "AI usage" section that contributors can fill in or delete.
Also adds a "Target branch" field to the enhancement, bug, and technical task issue templates.
References
Reviewer guidance
bug_issue.md,enhancement_issue.md,feature_issue.md,other_issue.md,product_issue.md,technical_task_issue.md,technical_tracking_issue.md) andPULL_REQUEST_TEMPLATE.mdhave the new DEEP section