Skip to content

chore: align pr templates - #750

Open
ovitrif wants to merge 3 commits into
masterfrom
chore/pr-template-out-of-scope
Open

ovitrif wants to merge 3 commits into
masterfrom
chore/pr-template-out-of-scope

Conversation

@ovitrif

@ovitrif ovitrif commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator

Closes #749

This PR gives the PR template one shape shared with bitkit-android: scope stated in the description, one line of design guidance, a ### Preview section, and QA Notes with its subsections.

Description

  • Adds an #### Out of Scope subsection at the end of ### Description so reviewers read the author's non-goals instead of guessing them.
  • Requires the subsection for feat, fix, and refactor PRs; version bumps, changelog, and release PRs skip it, and other chores include it at the author's discretion.
  • Asks for one bullet per change under ### Description, what changed and why, so the intent of each change is on record.
  • Replaces ### Linked Issues/Tasks with the Closes # comment at the top and turns placeholder text into comments so unfilled guidance does not land in PR bodies.
  • Shortens the ### Design guidance to one line; the full rules stay in the /pr command.
  • Renames ### Screenshot / Video to ### Preview, the heading the /pr command and the review tooling already key on, in the template and the release command body.
  • Adds ### QA Notes with #### Manual Tests and #### Automated Checks, the structure the /pr command already generates.
  • Teaches the /pr command the scope rules so agent-authored PRs follow them.

Out of Scope

  • .agents/commands/release.md: version-bump PRs keep their fixed body without the scope subsection; only the Preview heading was renamed.
  • Back-filling the sections on PRs that are already open.
  • Enforcing the sections in CI: a later change once the team has used them for a while.

Design

N/A — no UI changes.

Preview

N/A

QA Notes

Manual Tests

  • 1. Open a new PR in the GitHub UI: the template shows #### Out of Scope at the end of ### Description, a one-line ### Design comment, ### Preview, and ### QA Notes with #### Manual Tests and #### Automated Checks; no Linked Issues/Tasks section remains.

Automated Checks

N/A — template and command text only.

@ovitrif ovitrif self-assigned this Sep 14, 2026
@greptile-apps

greptile-apps Bot commented Sep 14, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

The documentation-only changes appear safe to merge.

Summary

  • Requires one what-and-why bullet per described change.
  • Adds an Out of scope section with exemptions for routine maintenance and release PRs.
  • Converts template guidance to comments and replaces the linked-issues section with a closing-keyword prompt.

Reviews (2) · Last reviewed commit: "chore: out of scope is required for feat..."

Comment thread .github/pull_request_template.md Outdated
@ovitrif ovitrif changed the title chore: PR template declares out-of-scope items and what-and-why bullets chore: require scope concerns in pr descriptions Sep 14, 2026
@ovitrif
ovitrif force-pushed the chore/pr-template-out-of-scope branch from 569a41d to 3ff5fad Compare September 14, 2026 15:42
@ovitrif ovitrif changed the title chore: require scope concerns in pr descriptions chore: make scope explicit in prs Sep 14, 2026
@ovitrif

ovitrif commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator Author

@greptileai review

@ovitrif ovitrif changed the title chore: make scope explicit in prs chore: align pr templates Sep 14, 2026
@ovitrif
ovitrif force-pushed the chore/pr-template-out-of-scope branch from 785b3c4 to 8e224a5 Compare September 14, 2026 17:36
@ovitrif
ovitrif force-pushed the chore/pr-template-out-of-scope branch from 8e224a5 to eadec51 Compare September 14, 2026 17:38
@ovitrif

ovitrif commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator Author

one review is enough, I added everyone for signing off / mainly covered by simply checking the PR description, feedback welcome.

@jvsena42 jvsena42 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Reviewed as a docs change, so the question is who acts on this and what do they get wrong — these files are executed by coding agents, not just read by humans. No blockers. Two LOW divergences inline, both in the direction of "the alignment pass missed a spot".

Neither is about wording. Both are places where an agent following the text literally produces a different result on iOS than on Android, which is the one thing a PR titled "align pr templates" should not leave behind.

The templates themselves are aligned. A mechanical diff of the two final pull_request_template.md files is one line — line 15, where Android points at docs/screens-map.md and iOS points at the Figma handoff URL. That is a legitimate per-repo difference: the screens map exists only in Android (git ls-tree on both heads), and the iOS URL matches AGENTS.md:342. The Description Rules and Out of Scope blocks in pr.md are byte-identical across the two repos.

Nothing required was dropped. I accounted for all 13 removed lines:

Removed Verdict
"summary of changes and which issues are fixed" survives at :7; issue linking moves to :1 closing keywords and pr.md:68-73
"List any dependencies that are required for this change" genuinely dropped — git grep -i "list any dependencies" finds nothing at head. Android never had it, so this is alignment, not loss
### Linked Issues/Tasks replaced by the :1 <!-- Closes | Fixes | Resolves #ISSUE_ID --> comment
"GitHub issues or Asana tasks" GitHub part survives; Asana genuinely droppedgit grep -i asana returns nothing in either repo at head
6-line ### Design comment block condensed into :15; the full contract survives in pr.md:121-130 and AGENTS.md:342-348
### Screenshot / Video renamed to ### Preview, and release.md:133 was updated in the same commit. git grep -i "Screenshot / Video" across the whole head returns nothing, so no dangling reference
"Insert relevant screenshot / recording" survives at :19, now with an N/A rule

Also checked: every path the new text references exists at head; no placeholder an agent would copy literally into a real PR (all new guidance sits inside HTML comments, and each live heading carries a fill-or-delete rule); .github/copilot-instructions.md carries no PR-description guidance, so nothing there conflicts.

The Android twin (synonymdev/bitkit-android#1262) came back clean — no findings — so these two are the only gaps between the pair.

Comment thread .github/pull_request_template.md
Comment thread .agents/commands/release.md
ben-kaufman
ben-kaufman previously approved these changes Sep 15, 2026
pwltr
pwltr previously approved these changes Sep 15, 2026
@ovitrif
ovitrif dismissed stale reviews from pwltr and ben-kaufman via b95b088 September 16, 2026 13:35
@ovitrif
ovitrif enabled auto-merge September 16, 2026 14:52
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.

chore: align pr templates

4 participants