Skip to content

Comments

Add DEEP framework AI usage guidance to issue and PR templates#46

Open
rtibbles wants to merge 2 commits intomainfrom
add-deep-framework-to-templates
Open

Add DEEP framework AI usage guidance to issue and PR templates#46
rtibbles wants to merge 2 commits intomainfrom
add-deep-framework-to-templates

Conversation

@rtibbles
Copy link
Member

@rtibbles rtibbles commented Feb 9, 2026

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

  • DEEP framework for AI usage guidelines

Reviewer guidance

  • Verify each issue template (bug_issue.md, enhancement_issue.md, feature_issue.md, other_issue.md, product_issue.md, technical_task_issue.md, technical_tracking_issue.md) and PULL_REQUEST_TEMPLATE.md have the new DEEP section
  • The DEEP guidance in the PR template has slightly different wording (mentions "Review code for correctness" instead of "Verify claims and sources") — this is intentional since the PR context is code-focused

@rtibbles rtibbles force-pushed the add-deep-framework-to-templates branch from 3a38bf4 to 31e2dad Compare February 11, 2026 02:13
rtibbles and others added 2 commits February 18, 2026 13:08
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>
@rtibbles rtibbles force-pushed the add-deep-framework-to-templates branch from 31e2dad to d44c2e8 Compare February 18, 2026 21:09
Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this @rtibbles.

One random & minor idea just for consideration if it too makes sense.

I read fully only bug_issue.md, since the template seems to be the same.

<!--
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And to allow for some exceptions, we could keep the previous phrasing?

If this issue was written with AI assistance, add:

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@MisRob MisRob self-assigned this Feb 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants