Skip to content

Add the AI usage section and mark the required sections #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akolson merged 1 commit into from
Oct 21, 2026
Merged

Add the AI usage section and mark the required sections #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,38 @@
<!-- Please remove any unused sections -->
<!-- Please remove any unused sections. Keep the sections marked REQUIRED. -->

@rtibblesbot rtibblesbot Oct 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick: This opening line now differs from learningequality/.github#115, which keeps its opening comment unchanged. The issue's Out of Scope limits this PR to ## AI usage and the markers. Revert this line, or make the same change in #115.


## Description
<!-- REQUIRED -->
<!-- What does this PR do? Briefly describe in 1-2 sentences* -->

#### Issue addressed
<!-- Only necessary if applicable -->

Addresses #*PR# HERE*

<!--
AI USAGE - REQUIRED

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:

@rtibblesbot rtibblesbot Oct 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

pre-existing: The "Using AI" link is malformed: as well sits inside the URL. The sentence also repeats "as well". This text is copied verbatim from learningequality/.github's .github/PULL_REQUEST_TEMPLATE.md. Fix it there first, then copy the fix here so the two stay identical.


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.
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 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."

-->

## AI usage
<!-- REQUIRED -->

@rtibblesbot rtibblesbot Oct 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

praise: Markers on the line after the heading (here and line 4) match learningequality/.github#115, so one parser handles both templates.

Loading