Check that pull requests follow the pull request template
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 58/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, javascript
调研方向
Start with scripts/sync-automation-template.js, automation-registry.yml, and the generated automation-group-pull-request-target.yml; compare the existing changelog.yml check and read docs/testing-automations.md. Test the changes in test-actions, including template-sync behavior and pull requests with missing, placeholder, valid, edited, and bot-authored bodies. Done means generated files are current and all acceptance criteria pass.
由索引模型根据 Issue 内容生成。
描述
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-systemchangelog check.
Acceptance Criteria
- The sync workflow proposes
PULL_REQUEST_TEMPLATE.mdto consumers without their own copy, and
skipskolibri-design-system,morangoandtest-actions. -
automation-registry.ymlholds apull-request-templateentry, and the generated files are
up to date. - A body with no template sections fails the run.
- A body with the sections but an empty
## AI usagefails the run. - A body that still holds
…fails the run. - The log of a failed run names every missing section, not only the first.
- A body that follows the template passes.
- Editing a bad body to a good one turns the check green.
- Bot authors pass.
- The check reads the repo template in a repo that holds one, and the org default elsewhere.
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-actionsanddry_run. Expect no template row,
becausetest-actionsholds its own copy.
References
- #97 added the sync workflow.
- #98 made
test-actionsthe place to test. - #101 grouped automation jobs by trigger event.
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.
- 主要语言
- JavaScript
- 星标
- 1
- 派生
- 7
- 平均合并
- 1 天 10 小时
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
learningequality/.github 的其他 Issue
-
dependencies github_actions
难度 4/5 3-5 天 新手友好度 15/100
learningequality/.github#100 ·
-
Create process for unplanned work and automate PR handling based on linked issue assignment可能重新可做 @akolson 于 180 天前认领,目前没有进行中的 PR。 未关闭github_actions
learningequality/.github#67 · 1 条评论 · 已指派 1 人 ·
查看 learningequality/.github 的全部 Issue
相似的 Issue
-
[Bug] @deck.gl/arcgis dist import resolves to unpublished @deck.gl/core source path (9.3.11, 9.4.0)未关闭
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
stac-utils/stac-fields#42 ·
-
agent/security hive/hosted-available-lke648397-260827-5n31 security
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 1 天内回复
-
channels:add check:passed
难度 1/5 1 小时以内 新手友好度 75/100
维护者通常 2 天内回复