Skip to content

Make pull request descriptions easier to understand - #148

Open
Mbeaulne wants to merge 1 commit into
mainfrom
MB/pr-description-template
Open

Mbeaulne wants to merge 1 commit into
mainfrom
MB/pr-description-template

Conversation

@Mbeaulne

@Mbeaulne Mbeaulne commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Intent

Make pull request descriptions easier to understand and review.

Current behavior

The template asks for a general description and testing steps, 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 descriptions around Intent, Current behavior, What changes, and How to test, while keeping screenshots and notes.
  • Adds one description-writing skill shared by Claude and Codex. It favors plain language and keeps technical details that help explain the change.
  • Starts testing instructions with concrete steps, assumes the usual frontend and backend are running, and calls out only extra setup or when no backend is needed.

How to test

No backend is needed for these authoring changes.

  1. In Files changed, preview the PR template. The first four sections should be Intent, Current behavior, What changes, and How to test, followed by Screenshots and Notes.
  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.

Screenshots

N/A

Notes

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

@Mbeaulne Mbeaulne changed the title Make pull request descriptions easier to understand WIP: Make pull request descriptions easier to understand Nov 2, 2026
@Mbeaulne Mbeaulne changed the title WIP: Make pull request descriptions easier to understand Make pull request descriptions easier to understand Nov 3, 2026

@camielvs camielvs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

small nit but my personal preference is to have screenshots near the top. They give a lot of context and it's annoying to scroll through the AI's wall of text time find them

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