Skip to content

docs: require PR_TITLE and PR_BODY for squash merges - #72

Merged
rianjs merged 2 commits into
mainfrom
docs-71-squash-title-invariant
Aug 3, 2026
Merged

docs: require PR_TITLE and PR_BODY for squash merges#72
rianjs merged 2 commits into
mainfrom
docs-71-squash-title-invariant

Conversation

@rianjs

@rianjs rianjs commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Require squash_merge_commit_title=PR_TITLE and squash_merge_commit_message=PR_BODY in the repository-settings standard.
  • Explain the one-commit COMMIT_OR_PR_TITLE bypass and the release dependency in release.md.
  • Keep the 13-repository settings rollout separate; this PR changes documentation only.

Validation

  • make check
  • git diff --check

Closes #71

@rianjs-bot rianjs-bot Bot 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.

Automated PR Review

Reviewed commit: 8da41445d945
Profile: codex-rianjs-bot - Posting as: rianjs-bot[bot]

Summary

Reviewer Findings
documentation:docs 1
policies:conventions 0
documentation:docs (1 finding)

Minor - docs/repo-layout.md:204

This new mandatory PR_BODY setting conflicts with §7's still-current description that the landing commit may contain either the PR description or branch commit messages, and that both squash-message modes are covered. That could lead maintainers to configure or reason about the prohibited commit-message mode. Update §7 to describe the now-required PR-title/PR-body shape and its corresponding CI coverage.

Reviewer Coverage

Reviewer Status Inspected Skipped Constraints
documentation:docs complete_broad docs/release.md, docs/repo-layout.md unavailable Documentation-only review; the artifact checkout's Git metadata was not usable, so review relied on the supplied change map and inspected final documentation.
policies:conventions complete_broad docs/release.md, docs/repo-layout.md unavailable Repository Git metadata was not accessible through the review environment, so the review used the supplied change map/intent and the checked-out document content.

0 PR discussion threads considered. 0 summarized; 0 resolved.


Completed in 36m 38s | unavailable | gpt-5.6-terra | cr 0.10.270
Field Value
Model gpt-5.6-terra
Reviewers documentation:docs, policies:conventions
Engine codex_cli · gpt-5.6-terra
Reviewed by cr · rianjs-bot[bot]
Duration 36m 38s wall · 1h 12m compute
Cost unavailable
Tokens 484.3k in / 6.6k out

Per-workstream usage

Workstream Model In Out Cache read Cache create Cost Duration
orchestrator-selection gpt-5.6-terra 16.6k 190 11.0k unavailable unavailable 6s
documentation:docs gpt-5.6-terra 245.3k 3.8k 207.9k unavailable unavailable 36m 18s
policies:conventions gpt-5.6-terra 187.7k 2.3k 152.8k unavailable unavailable 35m 52s
orchestrator-rollup gpt-5.6-terra 34.7k 287 27.1k unavailable unavailable 5s

Comment thread docs/repo-layout.md
### Merge settings
- **Squash merge only** (no merge commits, no rebase merge). This is why the PR
title must be a conventional commit (`release.md` §1).
- Set `squash_merge_commit_title=PR_TITLE` and

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This new mandatory PR_BODY setting conflicts with §7's still-current description that the landing commit may contain either the PR description or branch commit messages, and that both squash-message modes are covered. That could lead maintainers to configure or reason about the prohibited commit-message mode. Update §7 to describe the now-required PR-title/PR-body shape and its corresponding CI coverage.

Reply inline to this comment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 5cb1ed0: §7 now describes only the required PR_TITLE/PR_BODY landing shape and the corresponding PR title/body CI coverage. The prohibited COMMIT_MESSAGES alternative is no longer presented. make check passes.

@rianjs
rianjs merged commit 8fc89d1 into main Aug 3, 2026
4 checks passed
@rianjs
rianjs deleted the docs-71-squash-title-invariant branch August 3, 2026 12:08
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.

docs: make squash PR title/body settings a repository invariant

1 participant