Skip to content

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

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
rtibbles merged 2 commits into from
Oct 21, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08036b1
Add the AI usage section and mark the required sections
akolson Oct 21, 2026
ddcb0df
Put the AI usage comment under its heading
akolson Oct 21, 2026
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
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Summary
<!-- REQUIRED -->

*Short description*

@rtibblesbot rtibblesbot Oct 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nitpick: A PR that leaves *Short description* unchanged passes #102's required-section check. The check only flags the … placeholder. #102 rules out rewording this section. Leave the template as is; extend the check in learningequality/.github to flag this placeholder too.

@akolson akolson Oct 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in learningequality/.github@b1b7bac. A required section now fails when its text matches the same section in the template, so a body that keeps *Short description* fails. The untouched Changelog skeleton in kolibri-design-system fails for the same reason. A part filled section still passes: filling one Changelog bullet and keeping the rest is not flagged, because flagging that would also flag the bullet labels contributors are meant to keep.


Expand All @@ -19,3 +20,28 @@ List the issues solved or partly solved by the PR
## Documentation

If the PR has documentation, link the file here (either .rst in your repo or if built on Read The Docs)

## 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
Contributor

Choose a reason for hiding this comment

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

nitpick: The Using AI link duplicates as well: once inside the URL, once after it. The org template has the same typo at PULL_REQUEST_TEMPLATE.md:41. It sits inside an HTML comment, so readers never see it. No change needed here; if you fix it, fix both copies together.


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

-->
Loading