Skip to content

chore: standardize PR descriptions on functional change + before/after #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chaliy merged 1 commit into from
Jul 8, 2026
Merged

chore: standardize PR descriptions on functional change + before/after #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
## What
Clear description of the change.
## What changed
Describe the change functionally — what behavior changes and its impact on users
or callers. Lead with outcomes; don't walk through code locations, the diff shows
where and how. Keep any code-level notes short and specific.

## Why
Problem or motivation.

## How
High-level approach.
## Before / After
Show the effect with evidence. Include before and after whenever behavior changes —
CLI/API output, logs, metrics, or screenshots for UI (attach working screenshots
when possible). For changes with no observable behavior (pure refactor, docs), say so.

## Risk
- Low / Medium / High
Expand Down
16 changes: 12 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,17 +199,25 @@ npx commitlint --from HEAD~1 --to HEAD

PR titles should follow Conventional Commits format. Use the PR template (`.github/pull_request_template.md`) for descriptions.

Center the description on functional change and impact, not a code-location
walkthrough (the diff shows that). Add a Before / After with proof — CLI/API
output, logs, metrics, or screenshots for UI — whenever behavior changes.

**PR Body Template:**

```markdown
## What
Clear description of the change.
## What changed
Describe the change functionally — what behavior changes and its impact. Lead with
outcomes; don't walk through code locations, the diff shows where and how. Keep any
code-level notes short and specific.

## Why
Problem or motivation.

## How
High-level approach.
## Before / After
Show the effect with evidence. Include before and after whenever behavior changes —
CLI/API output, logs, metrics, or screenshots for UI (attach working screenshots
when possible). For changes with no observable behavior (pure refactor, docs), say so.

## Risk
- Low / Medium / High
Expand Down
Loading