Make AI use required in templates & update automated PR reply

MisRob · MisRob · commit d3f14c5d191e · 2026-03-17T20:36:22.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug_issue.md b/.github/ISSUE_TEMPLATE/bug_issue.md
@@ -9,6 +9,7 @@ type: Bug
 <!--
 Instructions:
  * Fill out the sections below, replace …'s with information about your issue
+ * REQUIRED: Always fill in the AI usage section at the bottom
  * Use the 'preview' function above this text box to verify formatting before submitting
 -->
 
@@ -69,10 +70,11 @@ Tell us about your environment, including:
 …
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+State explicitly whether you didn't use or used AI & how.
+
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -89,7 +91,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/ISSUE_TEMPLATE/enhancement_issue.md b/.github/ISSUE_TEMPLATE/enhancement_issue.md
@@ -10,6 +10,7 @@ Note that anything written between these symbols will not appear in the actual,
 
 Instructions:
 - Start by replacing the content in "[Title]" and give a "[Brief description]" of the issue above
+- REQUIRED: Always fill in the AI usage section at the bottom
 - Please remove any unused, optional sections below.
 
 -->
@@ -31,10 +32,11 @@ Instructions:
 
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+State explicitly whether you didn't use or used AI & how.
+
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -51,7 +53,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/ISSUE_TEMPLATE/feature_issue.md b/.github/ISSUE_TEMPLATE/feature_issue.md
@@ -7,6 +7,12 @@ type: Tracking Issue
 
 ---
 
+<!--
+
+- REQUIRED: Always fill in the AI usage section at the bottom
+
+-->
+
 ## Requirements
 
 ### What problem are we solving?
@@ -56,10 +62,11 @@ type: Tracking Issue
 - [Link]
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
+
+State explicitly whether you didn't use or used AI & how.
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -76,7 +83,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md
@@ -3,15 +3,22 @@ name: Other issue
 about: For issues that don't fit any other category
 ---
 
+<!--
+
+- REQUIRED: Always fill in the AI usage section at the bottom
+
+-->
+
 ## Description
 
 
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
+
+State explicitly whether you didn't use or used AI & how.
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -28,7 +35,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/ISSUE_TEMPLATE/product_issue.md b/.github/ISSUE_TEMPLATE/product_issue.md
@@ -4,6 +4,12 @@ about: Create a product issue
 type: Tracking Issue
 ---
 
+<!--
+
+- REQUIRED: Always fill in the AI usage section at the bottom
+
+-->
+
 _[General guidance: Product issues should describe the feature, but are not actually technically specced for dev work.]_
 
 ## Overview
@@ -23,10 +29,11 @@ _[Then, more detail. Provide a short summary and/or list key outcomes that the u
 
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
+
+State explicitly whether you didn't use or used AI & how.
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -43,7 +50,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/ISSUE_TEMPLATE/technical_task_issue.md b/.github/ISSUE_TEMPLATE/technical_task_issue.md
@@ -6,6 +6,7 @@ type: Task
 
 <!--
 Instructions:
+- REQUIRED: Always fill in the AI usage section at the bottom
 - Fill in Overview, The Change, and Acceptance Criteria (required)
 - Delete any optional sections you don't need
 - Remove all instructional comments before submitting
@@ -103,10 +104,11 @@ Links to documentation, code references, or relevant libraries.
 -->
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+State explicitly whether you didn't use or used AI & how.
+
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -123,7 +125,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/ISSUE_TEMPLATE/technical_tracking_issue.md b/.github/ISSUE_TEMPLATE/technical_tracking_issue.md
@@ -7,6 +7,7 @@ type: Tracking Issue
 
 <!--
 Instructions:
+- REQUIRED: Always fill in the AI usage section at the bottom
 - Fill in Overview and Scope (required)
 - Delete any optional sections you don't need
 - Remove all instructional comments before submitting
@@ -53,10 +54,11 @@ Otherwise, leave testing guidance to individual task issues.
 -->
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
 
-If AI was used in preparing this issue, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+State explicitly whether you didn't use or used AI & how.
+
+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:
 
   Disclose - Be open about when you've used AI for support.
   Engage critically - Question what is generated. Verify claims and sources.
@@ -73,7 +75,6 @@ Examples of good disclosures:
   cross-checked the key points against the original feedback and rewrote
   the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,9 @@
 <!--
- 1. Following guidance below, replace …'s with your own words
- 2. After saving the PR, tick of completed checklist items
- 3. Skip checklist items that are not applicable or not necessary
- 4. Delete instruction/comment blocks
+ 1. REQUIRED: Always fill in the AI usage section at the bottom
+ 2. Following guidance below, replace …'s with your own words
+ 3. After saving the PR, tick of completed checklist items
+ 4. Skip checklist items that are not applicable or not necessary
+ 5. Delete instruction/comment blocks
 -->
 
 ## Summary
@@ -31,28 +32,27 @@
 …
 
 <!--
-AI USAGE - DEEP guidelines
+AI USAGE - REQUIRED
 
-If AI was used in preparing this PR, please fill in the section below.
-Our DEEP guidelines ask that when using AI you:
+State explicitly whether you didn't use or used AI & how.
+
+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:
 
   Disclose - Be open about when you've used AI for support.
-  Engage critically - Question what is generated. Review code for correctness and unnecessary complexity.
-  Edit - Review and refine AI output. Remove unnecessary code and verify it still works after your edits.
+  Engage critically - Question what is generated. Verify claims and sources.
+  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:
 
-  "I used Claude Code to implement the component, prompting it to follow
-  the pattern in ComponentX. I reviewed the generated code, removed
-  unnecessary error handling, and verified the tests pass."
+  "I used Gemini to help draft this issue from my rough notes. I edited
+  the description for accuracy, confirmed the reproduction steps myself,
+  and trimmed the verbose output."
 
-  "I brainstormed the approach with Gemini, then had it write failing
-  tests for the feature. After reviewing the tests, I used Claude Code
-  to generate the implementation. I refactored the output to reduce
-  verbosity and ran the full test suite."
+  "This is based on a Claude summary of clearinghouse feedback. I
+  cross-checked the key points against the original feedback and rewrote
+  the requirements in my own words."
 
-If AI was not used, delete the section below.
 -->
 
 ## AI usage
diff --git a/scripts/constants.js b/scripts/constants.js
@@ -92,7 +92,7 @@ const BOT_MESSAGE_ISSUE_NOT_OPEN = `Hi! 👋 \n\n Thanks so much for your intere
 
 const BOT_MESSAGE_ALREADY_ASSIGNED = `Hi! 👋 \n\n Thanks so much for your interest! **This issue is already assigned. Visit [Contributing guidelines](https://learningequality.org/contributing-to-our-open-code-base) to learn about the contributing process and how to find suitable issues. If there are no unassigned 'help wanted' issues available, please wait until new ones are added.** \n\n We really appreciate your willingness to help. 😊${GSOC_NOTE}`;
 
-const BOT_MESSAGE_PULL_REQUEST = `👋 Thanks for contributing! \n\n We will assign a reviewer within the next two weeks. In the meantime, please ensure that:\n\n- [ ] **You ran \`pre-commit\` locally**\n- [ ] **All issue requirements are satisfied**\n- [ ] **The contribution is aligned with our [Contributing guidelines](https://learningequality.org/contributing-to-our-open-code-base). Pay extra attention to [Using generative AI](https://learningequality.org/contributing-to-our-open-code-base/#using-generative-ai). Pull requests that don't follow the guidelines will be closed.**\n\nWe'll be in touch! 😊`;
+const BOT_MESSAGE_PULL_REQUEST = (author) => `👋 Hi @${author}, thanks for contributing! \n\n **For the review process to begin, please verify that the following is satisfied:**\n\n- [ ] **Contribution is aligned with our [contributing guidelines](https://learningequality.org/contributing-to-our-open-code-base)**\n- [ ] **Pull request description has correctly filled _AI usage_ section & follows our AI guidance:**\n\n    <details>\n    <summary><b><i>AI guidance</i></b></summary>\n\n    <br>\n\n    **State explicitly whether you didn't use or used AI & how.**\n\n    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 our DEEP framework. DEEP asks you:\n\n    - **Disclose** — Be open about when you've used AI for support.\n    - **Engage critically** — Question what is generated. Verify claims and sources.\n    - **Edit** — Digest and refine AI output rather than copy-pasting it.\n    - **Process sharing** — Explain how you used the AI so others can learn.\n\n    <br>\n\n    Examples of good disclosures:\n\n    > "I used Gemini to help draft this issue from my rough notes. I edited the description for accuracy, confirmed the reproduction steps myself, and trimmed the verbose output."\n\n    > "This is based on a Claude summary of clearinghouse feedback. I cross-checked the key points against the original feedback and rewrote the requirements in my own words."\n\n    </details>\n\nAlso check that issue requirements are satisfied & you ran \`pre-commit\` locally. \n\n**Pull requests that don't follow the guidelines will be closed.**\n\n**Reviewer assignment can take up to 2 weeks.**`;
 
 const HOLIDAY_MESSAGE = `Season's greetings! 👋 \n\n We'd like to thank everyone for another year of fruitful collaborations, engaging discussions, and for the continued support of our work. **Learning Equality will be on holidays from December 22 to January 5.** We look forward to much more in the new year and wish you a very happy holiday season!${GSOC_NOTE}`;
 
diff --git a/scripts/contributor-pr-reply.js b/scripts/contributor-pr-reply.js
@@ -7,8 +7,9 @@ module.exports = async ({ github, context, core }) => {
     const number = context.payload.pull_request.number;
     const url = context.payload.pull_request.html_url;
     const title = context.payload.pull_request.title;
+    const author = context.payload.pull_request.user.login;
 
-    const botMessageUrl = await sendBotMessage(number, BOT_MESSAGE_PULL_REQUEST, {
+    const botMessageUrl = await sendBotMessage(number, BOT_MESSAGE_PULL_REQUEST(author), {
       github,
       context,
       core,
