Skip to content

Fail the Semantic Diff check for commits without a description - #9097

Merged
cknitt merged 3 commits into
masterfrom
commit-description-check
Oct 28, 2026
Merged

cknitt merged 3 commits into
masterfrom
commit-description-check

Conversation

@cknitt

@cknitt cknitt commented Oct 28, 2026

Copy link
Copy Markdown
Member

PRs like #9075 have commits with only a subject and a sign-off, so their Semantic Diff cards are empty. The records format already requires a description, but nothing checked it. Human contributors couldn't know about it, and agents tend to skip it on small follow-up commits. In the last 80 PRs, #9075, #9090, #9031, #9049 and #9043 have such commits.

  • scripts/commitRecords.js --check <range> fails when a commit has no description, naming the commits and how to fix them. A description is a paragraph of prose, or a Why: section with content; object blocks, code or trailers alone don't count. --check works without --out.
  • semantic_diff.yml runs the check as the last step, after the page and comment are posted, so the comment still shows the records. Fork PRs run the default branch's script, as for rendering.
  • CONTRIBUTING.md has a new "Commit messages" section with a minimal example and the local check command. The PR template has a checkbox, and AGENTS.md and the records skill say follow-up commits need a description too.

New test: --check names the commits without a description and fails covers prose, a Why: block and a Why: line passing, and subject-only, trailers-only, blocks-only and empty-Why: commits failing.

To make the check block merging, add the Semantic Diff job to the required checks.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Kbf3gJ4f9jQinqHFuszdea

Commits with only a subject, like #9075's, leave their Semantic Diff
cards empty. The records format already requires a description;
`commitRecords.js --check` now enforces it after the comment is drawn,
and CONTRIBUTING.md, the PR template and AGENTS.md say so.

Diagnostic added (commit without a description):
After (text):
    A commit has no description:

      a1bc9e1 Add missing JSX DOM event bindings

    Below its subject, a commit message says why the commit is made, as a line
    or two of prose or a `Why:` section (see "Commit messages" in
    CONTRIBUTING.md). Add one with `git rebase -i`, marking these commits
    `reword`, or squash them into a commit that has one, and force-push.

Review: What counts as a description? A paragraph of prose, or a `Why:`
section with content. Object blocks, code and trailers alone don't count.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Kbf3gJ4f9jQinqHFuszdea
Signed-off-by: Christoph Knittel <ck@cca.io>
@github-actions

github-actions Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Changelog

🏠 Internal

  • Fail the Semantic Diff check when a commit message has no description below its subject.

Semantic Diff

3 commits · Full page

Fail the Semantic Diff check for commits without a description

2218c1c · cknitt + Claude · Oct 28, 2026, 13:40 UTC

Commits with only a subject, like #9075's, leave their Semantic Diff cards empty. The records format already requires a description; commitRecords.js --check now enforces it after the comment is drawn, and CONTRIBUTING.md, the PR template and AGENTS.md say so.

Diagnostic added (commit without a description)

text · After

A commit has no description:

  a1bc9e110 Add missing JSX DOM event bindings

Below its subject, a commit message says why the commit is made, as a line
or two of prose or a `Why:` section (see "Commit messages" in
CONTRIBUTING.md). Add one with `git rebase -i`, marking these commits
`reword`, or squash them into a commit that has one, and force-push.

Review

  • What counts as a description? A paragraph of prose, or a Why: section with content. Object blocks, code and trailers alone don't count.
Leave the check command out of the records skill

4da09b6 · cknitt + Claude · Oct 28, 2026, 13:50 UTC

The skill already requires a description, and the failing check explains itself, so naming the script there adds nothing.

✨ List the commit description before the sign-off in the PR template

c494d71 · cknitt + Claude · Oct 28, 2026, 13:50 UTC · new

The checklist now follows the order of a commit message: the description comes before the Signed-off-by trailer.

@codecov

codecov Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.46%. Comparing base (83f5eea) to head (c494d71).
⚠️ Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9097      +/-   ##
==========================================
+ Coverage   81.43%   81.46%   +0.03%     
==========================================
  Files         459      460       +1     
  Lines       64546    64675     +129     
==========================================
+ Hits        52560    52689     +129     
  Misses      11986    11986              

see 46 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

cknitt and others added 2 commits October 28, 2026 13:50
The skill already requires a description, and the failing check
explains itself, so naming the script there adds nothing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Kbf3gJ4f9jQinqHFuszdea
Signed-off-by: Christoph Knittel <ck@cca.io>
The checklist now follows the order of a commit message: the
description comes before the Signed-off-by trailer.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Kbf3gJ4f9jQinqHFuszdea
Signed-off-by: Christoph Knittel <ck@cca.io>
@cknitt
cknitt marked this pull request as ready for review October 28, 2026 13:54
@cknitt

cknitt commented Oct 28, 2026

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-28T13:55:55.759096Z c494d71 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

Reviewed commit: c494d71eda

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@cknitt
cknitt requested a review from cristianoc October 28, 2026 13:56
@cknitt
cknitt enabled auto-merge (squash) October 28, 2026 13:56
@pkg-pr-new

pkg-pr-new Bot commented Oct 28, 2026

Copy link
Copy Markdown

Open in StackBlitz

rescript

npm i https://pkg.pr.new/rescript@9097

@rescript/belt

npm i https://pkg.pr.new/@rescript/belt@9097

@rescript/darwin-arm64

npm i https://pkg.pr.new/@rescript/darwin-arm64@9097

@rescript/linux-arm64

npm i https://pkg.pr.new/@rescript/linux-arm64@9097

@rescript/linux-x64

npm i https://pkg.pr.new/@rescript/linux-x64@9097

@rescript/runtime

npm i https://pkg.pr.new/@rescript/runtime@9097

@rescript/win32-x64

npm i https://pkg.pr.new/@rescript/win32-x64@9097

commit: c494d71

@cknitt
cknitt merged commit 85f31fb into master Oct 28, 2026
26 checks passed
@cknitt
cknitt deleted the commit-description-check branch October 28, 2026 14:07
@github-actions

Copy link
Copy Markdown

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