Overview
Contributors open pull requests that do not follow the pull request template. Reviewers then ask
for the missing information by hand.
Make the template reachable in every consumer repo, and check it through the automation entry point.
The check fails the run when the body does not follow the template.
Complexity: Medium
Target branch: main
Context
A sample of the most recent pull requests from non-members shows three separate failures:
| Repo |
Sampled |
No template sections |
## AI usage missing |
… placeholders left |
kolibri |
8 |
3 |
1 |
1 |
studio |
12 |
2 |
2 |
3 |
kolibri-design-system |
6 |
0 |
0 |
0 |
The template is not one check. A body can carry the headings and still leave ## AI usage empty,
which the template marks as required.
kolibri-design-system is the outlier, and the reason is where the file sits. It holds its own
template at .github/pull_request_template.md. morango and test-actions hold their own too.
kolibri, studio, le-utils, kolibri-app and kolibri-installer-android hold none, so they
fall back to the org default in this repo at .github/PULL_REQUEST_TEMPLATE.md.
GitHub applies an org default in the web form. A pull request opened with gh pr create, the REST
API, or a coding agent reads the working copy instead, and the org file is not in the working copy.
A contributor in a kolibri checkout therefore has no template to follow.
kolibri-design-system already enforces one section in .github/workflows/changelog.yml. It reads
the body, fails the job when the section is absent or still the placeholder text, and exempts
dependabot[bot]. It is the model for the check here.
The Change
Put the template in the checkout. Extend scripts/sync-automation-template.js so it carries
PULL_REQUEST_TEMPLATE.md to consumers alongside automation-template.yml. Skip any repo that
holds its own template. This prevents the failure rather than reporting it, because the file then
sits where every tool looks for it.
Add a pull-request-template automation. Add an entry to automation-registry.yml with a leaf
that reads github.event.pull_request.body. The leaf resolves the template the same way GitHub
does, repo copy first and org default second, then takes the required sections from it. The
generator places the job in automation-group-pull-request-target.yml.
The check reports three things:
- A required section heading is absent.
- A required section holds no text.
- A section still holds the
… placeholder.
Fail the run. The job exits non-zero, as changelog.yml does.
The job log is the only channel, so it must name every missing section rather than fail on the
first one.
Notes for the implementer
Trigger on pull_request_target types opened, edited and reopened, so a corrected body clears
the check. The template on: block currently carries labeled, opened and review_requested, so
edited and reopened are new. Every consumer needs the widened template, which the sync workflow
proposes on its next run.
Exempt bot authors, as changelog.yml does.
Out of Scope
- Changing the wording of the template.
- Posting a comment on the pull request. The failed check is the only report.
- Making the check required in branch protection. That is a repo setting, and it follows once the
check runs clean.
- Changing the
kolibri-design-system changelog check.
Acceptance Criteria
Testing
Test in test-actions. See
testing the automations.
The contributor cases need an account outside the organization.
- Open a pull request with an empty body. Expect a failed check that names every missing section.
- Edit the body to follow the template. Expect the check to pass.
- Open a pull request that follows the template. Expect a passing check.
- Dispatch the sync workflow with
only: test-actions and dry_run. Expect no template row,
because test-actions holds its own copy.
References
AI usage
I used Claude Code to sample recent contributor pull requests, to check which repos hold their own
template, and to read the kolibri-design-system changelog check. I decided the approach and
verified the findings against the repos.
Overview
Contributors open pull requests that do not follow the pull request template. Reviewers then ask
for the missing information by hand.
Make the template reachable in every consumer repo, and check it through the automation entry point.
The check fails the run when the body does not follow the template.
Complexity: Medium
Target branch: main
Context
A sample of the most recent pull requests from non-members shows three separate failures:
## AI usagemissing…placeholders leftkolibristudiokolibri-design-systemThe template is not one check. A body can carry the headings and still leave
## AI usageempty,which the template marks as required.
kolibri-design-systemis the outlier, and the reason is where the file sits. It holds its owntemplate at
.github/pull_request_template.md.morangoandtest-actionshold their own too.kolibri,studio,le-utils,kolibri-appandkolibri-installer-androidhold none, so theyfall back to the org default in this repo at
.github/PULL_REQUEST_TEMPLATE.md.GitHub applies an org default in the web form. A pull request opened with
gh pr create, the RESTAPI, or a coding agent reads the working copy instead, and the org file is not in the working copy.
A contributor in a
kolibricheckout therefore has no template to follow.kolibri-design-systemalready enforces one section in.github/workflows/changelog.yml. It readsthe body, fails the job when the section is absent or still the placeholder text, and exempts
dependabot[bot]. It is the model for the check here.The Change
Put the template in the checkout. Extend
scripts/sync-automation-template.jsso it carriesPULL_REQUEST_TEMPLATE.mdto consumers alongsideautomation-template.yml. Skip any repo thatholds its own template. This prevents the failure rather than reporting it, because the file then
sits where every tool looks for it.
Add a
pull-request-templateautomation. Add an entry toautomation-registry.ymlwith a leafthat reads
github.event.pull_request.body. The leaf resolves the template the same way GitHubdoes, repo copy first and org default second, then takes the required sections from it. The
generator places the job in
automation-group-pull-request-target.yml.The check reports three things:
…placeholder.Fail the run. The job exits non-zero, as
changelog.ymldoes.The job log is the only channel, so it must name every missing section rather than fail on the
first one.
Notes for the implementer
Trigger on
pull_request_targettypesopened,editedandreopened, so a corrected body clearsthe check. The template
on:block currently carrieslabeled,openedandreview_requested, soeditedandreopenedare new. Every consumer needs the widened template, which the sync workflowproposes on its next run.
Exempt bot authors, as
changelog.ymldoes.Out of Scope
check runs clean.
kolibri-design-systemchangelog check.Acceptance Criteria
PULL_REQUEST_TEMPLATE.mdto consumers without their own copy, andskips
kolibri-design-system,morangoandtest-actions.automation-registry.ymlholds apull-request-templateentry, and the generated files areup to date.
## AI usagefails the run.…fails the run.Testing
Test in
test-actions. Seetesting the automations.
The contributor cases need an account outside the organization.
only: test-actionsanddry_run. Expect no template row,because
test-actionsholds its own copy.References
test-actionsthe place to test.AI usage
I used Claude Code to sample recent contributor pull requests, to check which repos hold their own
template, and to read the
kolibri-design-systemchangelog check. I decided the approach andverified the findings against the repos.