Skip to content

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

Merged
akolson merged 1 commit into
mainfrom
template-ai-usage-and-markers
Oct 21, 2026
Merged

akolson merged 1 commit into
mainfrom
template-ai-usage-and-markers

Conversation

@akolson

@akolson akolson commented Oct 21, 2026

Copy link
Copy Markdown
Member

Description

This is where the automations are tested, so its template needs the same shape as the ones the
check will run against. This adds an AI usage section, with the wording copied from the shared
template in learningequality/.github,
and marks Description and AI usage with a <!-- REQUIRED --> comment.

learningequality/.github#102 adds the check that reads those markers. Testing it needs a repo
that holds its own template, which this one does, so the cases for a repo-specific template run
here.

The opening line now reads "Please remove any unused sections. Keep the sections marked
REQUIRED.", because the old wording tells a contributor to do the one thing the check fails
them for.

Issue addressed

Addresses learningequality/.github#102

AI usage

I used Claude Code to read the template and 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, leq-bot and rtibblesbot October 21, 2026 13:07
@rtibblesbot

rtibblesbot commented Oct 21, 2026 •

Copy link
Copy Markdown

🟡 Waiting for changes

Outcome: reviewed b2e8a05

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

@rtibblesbot rtibblesbot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

PR #102 adds ## AI usage and the <!-- REQUIRED --> markers required by learningequality/.github#102. Marker placement matches the org template in learningequality/.github#115.

CI passing.

  • nitpick: opening line reworded beyond the issue's scope (inline)
  • pre-existing: malformed "Using AI" link copied from the shared template (inline)

Next step: Needs a full code review by a human engineer.

  • The author is outside the team: confirm this should be built at all.

Written by rtibblesbot, an LLM-based coding agent.

@@ -1,9 +1,38 @@
<!-- Please remove any unused sections -->
<!-- Please remove any unused sections. Keep the sections marked REQUIRED. -->

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.


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

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.

-->

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

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.

@akolson
akolson merged commit ebd128a into main Oct 21, 2026
51 checks passed
@rtibblesbot

Copy link
Copy Markdown

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.

2 participants