Skip to content

Commit 0faac06

Browse files
rtibblesrtibbles
authored
Merge pull request #46 from learningequality/add-deep-framework-to-templates
Add DEEP framework AI usage guidance to issue and PR templates
2 parents bdd8941 + 142da9f commit 0faac06

8 files changed

Lines changed: 193 additions & 14 deletions

‎.github/ISSUE_TEMPLATE/bug_issue.md‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Instructions:
1212
* Use the 'preview' function above this text box to verify formatting before submitting
1313
-->
1414

15+
**Target branch:** <!-- e.g. develop, release-0.17.x -->
16+
1517
## Observed behavior
1618
<!--
1719
Description of the behavior that was observed, including screenshots or other references when applicable
@@ -67,6 +69,27 @@ Tell us about your environment, including:
6769
…
6870

6971
<!--
70-
AI DISCLOSURE: If this issue was written with AI assistance, add:
71-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
72+
AI USAGE - DEEP guidelines
73+
74+
If AI was used in preparing this issue, please fill in the section below.
75+
Our DEEP guidelines ask that when using AI you:
76+
77+
Disclose - Be open about when you've used AI for support.
78+
Engage critically - Question what is generated. Verify claims and sources.
79+
Edit - Digest and refine AI output rather than copy-pasting it.
80+
Process sharing - Explain how you used the AI so others can learn.
81+
82+
Examples of good disclosures:
83+
84+
"I used Gemini to help draft this issue from my rough notes. I edited
85+
the description for accuracy, confirmed the reproduction steps myself,
86+
and trimmed the verbose output."
87+
88+
"This is based on a Claude summary of clearinghouse feedback. I
89+
cross-checked the key points against the original feedback and rewrote
90+
the requirements in my own words."
91+
92+
If AI was not used, delete the section below.
7293
-->
94+
95+
## AI usage

‎.github/ISSUE_TEMPLATE/enhancement_issue.md‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Instructions:
1414
1515
-->
1616

17+
**Target branch:** <!-- e.g. develop, release-0.17.x -->
18+
1719
## Current behavior
1820
<!-- Briefly describe the current behavior; you may include screenshots, code, and notes -->
1921

@@ -29,6 +31,27 @@ Instructions:
2931

3032

3133
<!--
32-
AI DISCLOSURE: If this issue was written with AI assistance, add:
33-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
34+
AI USAGE - DEEP guidelines
35+
36+
If AI was used in preparing this issue, please fill in the section below.
37+
Our DEEP guidelines ask that when using AI you:
38+
39+
Disclose - Be open about when you've used AI for support.
40+
Engage critically - Question what is generated. Verify claims and sources.
41+
Edit - Digest and refine AI output rather than copy-pasting it.
42+
Process sharing - Explain how you used the AI so others can learn.
43+
44+
Examples of good disclosures:
45+
46+
"I used Gemini to help draft this issue from my rough notes. I edited
47+
the description for accuracy, confirmed the reproduction steps myself,
48+
and trimmed the verbose output."
49+
50+
"This is based on a Claude summary of clearinghouse feedback. I
51+
cross-checked the key points against the original feedback and rewrote
52+
the requirements in my own words."
53+
54+
If AI was not used, delete the section below.
3455
-->
56+
57+
## AI usage

‎.github/ISSUE_TEMPLATE/feature_issue.md‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,27 @@ _[Issues should be attached as sub issues as they are created. There will probab
4141

4242

4343
<!--
44-
AI DISCLOSURE: If this issue was written with AI assistance, add:
45-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
44+
AI USAGE - DEEP guidelines
45+
46+
If AI was used in preparing this issue, please fill in the section below.
47+
Our DEEP guidelines ask that when using AI you:
48+
49+
Disclose - Be open about when you've used AI for support.
50+
Engage critically - Question what is generated. Verify claims and sources.
51+
Edit - Digest and refine AI output rather than copy-pasting it.
52+
Process sharing - Explain how you used the AI so others can learn.
53+
54+
Examples of good disclosures:
55+
56+
"I used Gemini to help draft this issue from my rough notes. I edited
57+
the description for accuracy, confirmed the reproduction steps myself,
58+
and trimmed the verbose output."
59+
60+
"This is based on a Claude summary of clearinghouse feedback. I
61+
cross-checked the key points against the original feedback and rewrote
62+
the requirements in my own words."
63+
64+
If AI was not used, delete the section below.
4665
-->
66+
67+
## AI usage

‎.github/ISSUE_TEMPLATE/other_issue.md‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,27 @@ about: For issues that don't fit any other category
88

99

1010
<!--
11-
AI DISCLOSURE: If this issue was written with AI assistance, add:
12-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
11+
AI USAGE - DEEP guidelines
12+
13+
If AI was used in preparing this issue, please fill in the section below.
14+
Our DEEP guidelines ask that when using AI you:
15+
16+
Disclose - Be open about when you've used AI for support.
17+
Engage critically - Question what is generated. Verify claims and sources.
18+
Edit - Digest and refine AI output rather than copy-pasting it.
19+
Process sharing - Explain how you used the AI so others can learn.
20+
21+
Examples of good disclosures:
22+
23+
"I used Gemini to help draft this issue from my rough notes. I edited
24+
the description for accuracy, confirmed the reproduction steps myself,
25+
and trimmed the verbose output."
26+
27+
"This is based on a Claude summary of clearinghouse feedback. I
28+
cross-checked the key points against the original feedback and rewrote
29+
the requirements in my own words."
30+
31+
If AI was not used, delete the section below.
1332
-->
33+
34+
## AI usage

‎.github/ISSUE_TEMPLATE/product_issue.md‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,27 @@ _[Then, more detail. Provide a short summary and/or list key outcomes that the u
2323

2424

2525
<!--
26-
AI DISCLOSURE: If this issue was written with AI assistance, add:
27-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
26+
AI USAGE - DEEP guidelines
27+
28+
If AI was used in preparing this issue, please fill in the section below.
29+
Our DEEP guidelines ask that when using AI you:
30+
31+
Disclose - Be open about when you've used AI for support.
32+
Engage critically - Question what is generated. Verify claims and sources.
33+
Edit - Digest and refine AI output rather than copy-pasting it.
34+
Process sharing - Explain how you used the AI so others can learn.
35+
36+
Examples of good disclosures:
37+
38+
"I used Gemini to help draft this issue from my rough notes. I edited
39+
the description for accuracy, confirmed the reproduction steps myself,
40+
and trimmed the verbose output."
41+
42+
"This is based on a Claude summary of clearinghouse feedback. I
43+
cross-checked the key points against the original feedback and rewrote
44+
the requirements in my own words."
45+
46+
If AI was not used, delete the section below.
2847
-->
48+
49+
## AI usage

‎.github/ISSUE_TEMPLATE/technical_task_issue.md‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Keep it brief - a few sentences.
1919
-->
2020

2121
**Complexity:** Low | Medium | High
22+
**Target branch:** <!-- e.g. develop, release-0.17.x -->
2223

2324
### Context
2425

@@ -102,6 +103,27 @@ Links to documentation, code references, or relevant libraries.
102103
-->
103104

104105
<!--
105-
AI DISCLOSURE: If this issue was written with AI assistance, add:
106-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
106+
AI USAGE - DEEP guidelines
107+
108+
If AI was used in preparing this issue, please fill in the section below.
109+
Our DEEP guidelines ask that when using AI you:
110+
111+
Disclose - Be open about when you've used AI for support.
112+
Engage critically - Question what is generated. Verify claims and sources.
113+
Edit - Digest and refine AI output rather than copy-pasting it.
114+
Process sharing - Explain how you used the AI so others can learn.
115+
116+
Examples of good disclosures:
117+
118+
"I used Gemini to help draft this issue from my rough notes. I edited
119+
the description for accuracy, confirmed the reproduction steps myself,
120+
and trimmed the verbose output."
121+
122+
"This is based on a Claude summary of clearinghouse feedback. I
123+
cross-checked the key points against the original feedback and rewrote
124+
the requirements in my own words."
125+
126+
If AI was not used, delete the section below.
107127
-->
128+
129+
## AI usage

‎.github/ISSUE_TEMPLATE/technical_tracking_issue.md‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,27 @@ Otherwise, leave testing guidance to individual task issues.
5353
-->
5454

5555
<!--
56-
AI DISCLOSURE: If this issue was written with AI assistance, add:
57-
🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖
56+
AI USAGE - DEEP guidelines
57+
58+
If AI was used in preparing this issue, please fill in the section below.
59+
Our DEEP guidelines ask that when using AI you:
60+
61+
Disclose - Be open about when you've used AI for support.
62+
Engage critically - Question what is generated. Verify claims and sources.
63+
Edit - Digest and refine AI output rather than copy-pasting it.
64+
Process sharing - Explain how you used the AI so others can learn.
65+
66+
Examples of good disclosures:
67+
68+
"I used Gemini to help draft this issue from my rough notes. I edited
69+
the description for accuracy, confirmed the reproduction steps myself,
70+
and trimmed the verbose output."
71+
72+
"This is based on a Claude summary of clearinghouse feedback. I
73+
cross-checked the key points against the original feedback and rewrote
74+
the requirements in my own words."
75+
76+
If AI was not used, delete the section below.
5877
-->
78+
79+
## AI usage

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,30 @@
2929
-->
3030

3131
…
32+
33+
<!--
34+
AI USAGE - DEEP guidelines
35+
36+
If AI was used in preparing this PR, please fill in the section below.
37+
Our DEEP guidelines ask that when using AI you:
38+
39+
Disclose - Be open about when you've used AI for support.
40+
Engage critically - Question what is generated. Review code for correctness and unnecessary complexity.
41+
Edit - Review and refine AI output. Remove unnecessary code and verify it still works after your edits.
42+
Process sharing - Explain how you used the AI so others can learn.
43+
44+
Examples of good disclosures:
45+
46+
"I used Claude Code to implement the component, prompting it to follow
47+
the pattern in ComponentX. I reviewed the generated code, removed
48+
unnecessary error handling, and verified the tests pass."
49+
50+
"I brainstormed the approach with Gemini, then had it write failing
51+
tests for the feature. After reviewing the tests, I used Claude Code
52+
to generate the implementation. I refactored the output to reduce
53+
verbosity and ran the full test suite."
54+
55+
If AI was not used, delete the section below.
56+
-->
57+
58+
## AI usage

0 commit comments

Comments
 (0)