Skip to content

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

Merged
rtibbles merged 2 commits into
release-v0.9.xfrom
template-ai-usage-and-markers
Oct 21, 2026
Merged

rtibbles merged 2 commits into
release-v0.9.xfrom
template-ai-usage-and-markers

Conversation

@akolson

@akolson akolson commented Oct 21, 2026

Copy link
Copy Markdown
Member

Summary

This template predates the AI usage policy, so it never asked for the disclosure that the
shared template in learningequality/.github
asks for. A search of this file for "AI", "generative" or "DEEP" returns nothing. This adds the
section, with the wording copied from the shared template so every repo asks the same thing.

It also marks the sections a pull request must carry, with a <!-- REQUIRED --> comment.
learningequality/.github#102 adds a check that reads those markers. A section without a marker
stays optional.

Summary and AI usage are marked. TODO, Reviewer guidance, Issues addressed and Documentation
are not, because each one is situational.

Nothing enforces the markers yet. The check lands later.

Reviewer guidance

  1. Read the diff. Expect the new AI usage block at the end and two <!-- REQUIRED --> lines.
  2. Open a pull request in this repo and check that the rendered description is unchanged apart
    from the new heading, because a comment does not render.

Issues addressed

learningequality/.github#102

AI usage

I used Claude Code to find that this template asks for no disclosure and to make the edit. The
wording is copied from the shared template. I decided which sections are required, and I
reviewed the diff.

This template predates the AI usage policy, so it never asked for the
disclosure that learningequality/.github's shared template asks for. The
wording of the section is copied from that template, so every repo asks the
same thing.

The REQUIRED markers tell the shared template check which sections a pull
request body must carry. A section without a marker stays optional, so the
sections this template invites a contributor to remove can still be removed.
@akolson
akolson requested review from a team and leq-bot October 21, 2026 13:07
@akolson akolson assigned rtibblesbot and unassigned rtibblesbot Oct 21, 2026
@akolson
akolson requested a review from rtibblesbot October 21, 2026 13:11
@rtibblesbot

rtibblesbot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

🟡 Waiting for changes

Outcome: reviewed 08036b1

Last updated: 2026-10-21 13:17 UTC

@rtibblesbot rtibblesbot left a comment

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.

PR #397 matches learningequality/.github#102. The AI usage section is copied verbatim from the org template. Only Summary and AI usage carry <!-- REQUIRED -->.

CI passing.

  • Two nitpicks inline, neither for this PR to change.

Next step: This is a low-risk change and can merge as is, with no further human review.


Written by rtibblesbot, an LLM-based coding agent.


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:

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.

## Summary
<!-- REQUIRED -->

*Short description*

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.

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.

Every other section in this template carries its guidance comment after the
heading. The block added in the previous commit carried it before, so it read
as part of the section above it.

The comment also opened with "AI USAGE - REQUIRED", which the heading and the
REQUIRED marker now say.
@rtibbles
rtibbles merged commit 55e6e38 into release-v0.9.x Oct 21, 2026
27 checks passed
@rtibbles
rtibbles deleted the template-ai-usage-and-markers branch October 21, 2026 16:59
@rtibblesbot

Copy link
Copy Markdown
Contributor

Quick check on rtibblesbot's review of this PR: react 👍 helpful · 😕 mixed · 👎 not helpful. Reply with anything specific.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants