Skip to content

Commit 10fa737

Browse files
authored
Merge pull request #115 from learningequality/template-required-markers
Mark the required sections, and put the AI usage comment under its heading
2 parents 96ab329 + af6edc4 commit 10fa737

8 files changed

Lines changed: 20 additions & 33 deletions

‎.github/ISSUE_TEMPLATE/bug_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ Tell us about your environment, including:
6969

7070
…
7171

72+
## AI usage
73+
<!-- REQUIRED -->
7274
<!--
73-
AI USAGE - REQUIRED
74-
7575
State explicitly whether you didn't use or used AI & how.
7676
7777
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -92,5 +92,3 @@ Examples of good disclosures:
9292
the requirements in my own words."
9393
9494
-->
95-
96-
## AI usage

‎.github/ISSUE_TEMPLATE/enhancement_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Instructions:
3131
<!-- (Optional) Explain possible issues/costs that could arise - if any - from implementing this enhancement -->
3232

3333

34+
## AI usage
35+
<!-- REQUIRED -->
3436
<!--
35-
AI USAGE - REQUIRED
36-
3737
State explicitly whether you didn't use or used AI & how.
3838
3939
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -54,5 +54,3 @@ Examples of good disclosures:
5454
the requirements in my own words."
5555
5656
-->
57-
58-
## AI usage

‎.github/ISSUE_TEMPLATE/feature_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ type: Tracking Issue
6161

6262
- [Link]
6363

64+
## AI usage
65+
<!-- REQUIRED -->
6466
<!--
65-
AI USAGE - REQUIRED
66-
6767
State explicitly whether you didn't use or used AI & how.
6868
6969
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -84,5 +84,3 @@ Examples of good disclosures:
8484
the requirements in my own words."
8585
8686
-->
87-
88-
## AI usage

‎.github/ISSUE_TEMPLATE/other_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ about: For issues that don't fit any other category
1313

1414

1515

16+
## AI usage
17+
<!-- REQUIRED -->
1618
<!--
17-
AI USAGE - REQUIRED
18-
1919
State explicitly whether you didn't use or used AI & how.
2020
2121
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -36,5 +36,3 @@ Examples of good disclosures:
3636
the requirements in my own words."
3737
3838
-->
39-
40-
## AI usage

‎.github/ISSUE_TEMPLATE/product_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ _[Then, more detail. Provide a short summary and/or list key outcomes that the u
2828
### Accessibility Requirements
2929

3030

31+
## AI usage
32+
<!-- REQUIRED -->
3133
<!--
32-
AI USAGE - REQUIRED
33-
3434
State explicitly whether you didn't use or used AI & how.
3535
3636
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -51,5 +51,3 @@ Examples of good disclosures:
5151
the requirements in my own words."
5252
5353
-->
54-
55-
## AI usage

‎.github/ISSUE_TEMPLATE/technical_task_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ OPTIONAL - Delete if not needed.
103103
Links to documentation, code references, or relevant libraries.
104104
-->
105105

106+
## AI usage
107+
<!-- REQUIRED -->
106108
<!--
107-
AI USAGE - REQUIRED
108-
109109
State explicitly whether you didn't use or used AI & how.
110110
111111
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -126,5 +126,3 @@ Examples of good disclosures:
126126
the requirements in my own words."
127127
128128
-->
129-
130-
## AI usage

‎.github/ISSUE_TEMPLATE/technical_tracking_issue.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Only include if there's a unifying test strategy across sub-tasks.
5353
Otherwise, leave testing guidance to individual task issues.
5454
-->
5555

56+
## AI usage
57+
<!-- REQUIRED -->
5658
<!--
57-
AI USAGE - REQUIRED
58-
5959
State explicitly whether you didn't use or used AI & how.
6060
6161
If you used it, ensure that the issue is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -76,5 +76,3 @@ Examples of good disclosures:
7676
the requirements in my own words."
7777
7878
-->
79-
80-
## AI usage

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
<!--
2-
1. REQUIRED: Always fill in the AI usage section at the bottom
2+
1. REQUIRED: Fill in every section marked REQUIRED, including AI usage at the bottom
33
2. Following guidance below, replace …'s with your own words
44
3. After saving the PR, tick of completed checklist items
55
4. Skip checklist items that are not applicable or not necessary
66
5. Delete instruction/comment blocks
77
-->
88

99
## Summary
10+
<!-- REQUIRED -->
1011
<!--
1112
* headline description of the change
1213
* motivation for the change
@@ -16,13 +17,15 @@
1617
…
1718

1819
## References
20+
<!-- REQUIRED -->
1921
<!--
2022
* references to related issues and PRs
2123
-->
2224

2325
…
2426

2527
## Reviewer guidance
28+
<!-- REQUIRED -->
2629
<!--
2730
* manual verification steps you have performed
2831
* anything additional a reviewer can do to test these changes?
@@ -33,9 +36,9 @@
3336

3437
…
3538

39+
## AI usage
40+
<!-- REQUIRED -->
3641
<!--
37-
AI USAGE - REQUIRED
38-
3942
State explicitly whether you didn't use or used AI & how.
4043
4144
If you used it, ensure that the PR is aligned with [Using AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai as well) as well as our DEEP framework. DEEP asks you:
@@ -57,5 +60,3 @@ Examples of good disclosures:
5760
verbosity and ran the full test suite."
5861
5962
-->
60-
61-
## AI usage

0 commit comments

Comments
 (0)