Skip to content

docs(github): ask for one visual aid in pull request bodies - #321

Merged
altaywtf merged 1 commit into
mainfrom
docs/pr-template-visual-aid
Oct 5, 2026
Merged

altaywtf merged 1 commit into
mainfrom
docs/pr-template-visual-aid

Conversation

@altaywtf

@altaywtf altaywtf commented Oct 5, 2026

Copy link
Copy Markdown
Member

Change

The PR template now asks for one outcome sentence and one visual aid, and keeps test counts, command logs, file lists and review history out.

## Change

<!-- One sentence on the outcome, then one visual aid: a screenshot or short
recording for UI, a Mermaid diagram for a flow, a table for numbers, or a short
code sample for an API. ... -->

Validation

  • ./gradlew markdownCheck

Written by an agent (Claude Code, Opus 5.5)

Copilot AI balanced review requested due to automatic review settings October 5, 2026 05:31
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@altaywtf
altaywtf merged commit ae1aae4 into main Oct 5, 2026
10 checks passed
@altaywtf
altaywtf deleted the docs/pr-template-visual-aid branch October 5, 2026 05:33

Copilot AI 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.

Copilot review overview

🟢 Approval recommended

It is a self-contained docs-only edit to the PR template with consistent, grammatically correct guidance and no functional or formatting issues.

Review effort: Balanced
Findings: None

What changed in this PR

This PR revises the repository's GitHub pull request template (.github/pull_request_template.md) to steer contributors toward shorter, more focused PR bodies. It replaces the open-ended "Change" prompt with guidance to write one outcome sentence plus a single visual aid (screenshot/recording, Mermaid diagram, table, or code sample), and trims the validation guidance comment to drop the longer instructions while adding an "Unverified:" convention for skipped proof. It is a docs-only change with no functional code impact.

Changes:

  • Rewrote the "Change" section comment to request one outcome sentence and one visual aid, and to exclude test counts, command logs, file lists, and review history.
  • Condensed the validation guidance comment and introduced a single Unverified: line convention for skipped or unavailable proof.
File Description
.github/​pull_request_template.md Updates the two guidance HTML comments to ask for a concise outcome + visual aid and a condensed validation note.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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