Skip to content

Make pull request descriptions easier to understand - #2983

Merged
Mbeaulne merged 2 commits into
masterfrom
MB/pr-description-template
Nov 3, 2026
Merged

Mbeaulne merged 2 commits into
masterfrom
MB/pr-description-template

Conversation

@Mbeaulne

@Mbeaulne Mbeaulne commented Nov 2, 2026

Copy link
Copy Markdown
Collaborator

Intent

Make pull request descriptions easier to understand and review.

Current behavior

The template has a general description field, but gives little guidance on explaining the purpose, existing behavior, and resulting change. There is no shared skill for writing descriptions in that format.

What changes

  • Organizes the explanation around Intent, Current behavior, What changes, and How to test.
  • Adds a description-writing skill that uses plain language and includes technical details when they help explain the change. Codex finds the same skill through a link to the Claude definition, so the guidance is maintained in one place.
  • Gives numbered testing steps and expected results, assumes the usual frontend and backend are running, and mentions only extra setup or when no backend is needed.
  • Keeps the existing Screenshots section, checklist, related links, and line breakdown.

How to test

No backend is needed for these authoring changes.

  1. In Files changed, preview the PR template. The explanation should start with Intent, Current behavior, What changes, and How to test. The Screenshots section and existing review sections should still be present.
  2. Open this branch in Claude or Codex and ask it to use the pr-description skill to draft a description for a small change. The draft should explain why the change is needed, what happens today, and what changes, without a file-by-file summary.
  3. Check the testing section. It should give numbered actions and expected results, skip generic disclaimers, and mention setup only when an extra service is needed or the check works without a backend.

Local checks passed: formatting, skill metadata, shared-skill links, and whitespace.

Related Issue and Pull requests

Matching tangent-shell change.

Type of Change

  • Documentation update

Line Breakdown

Category Added Removed
Docs 48 0
Config / CI / tooling 21 6
Total 69 6

Checklist

  • I have tested this does not break current pipelines / runs functionality
  • I have tested the changes on staging

Screenshots (if applicable)

N/A

Additional Comments

The GitHub template takes effect for new PRs after this change is merged into master.

@Mbeaulne
Mbeaulne requested a review from a team as a code owner November 2, 2026 22:36
@github-actions

github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

🎩 Preview

A preview build has been created at: MB/pr-description-template/cb36c68

@camielvs camielvs left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

let's give it a whirl

@Mbeaulne
Mbeaulne enabled auto-merge (squash) November 3, 2026 17:03
@Mbeaulne
Mbeaulne merged commit 8cb3723 into master Nov 3, 2026
18 checks passed
@Mbeaulne
Mbeaulne deleted the MB/pr-description-template branch November 3, 2026 17:11
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