Back to list
tdhopper

creating-pull-requests

by tdhopper

The new dotfiles repo managed with yadm

2🍴 3📅 Jan 23, 2026

SKILL.md


Creating Pull Requests

Create well-structured pull requests with clear titles and comprehensive descriptions.

Critical Rules

NEVER do these:

  • Do NOT add yourself as a coauthor on commits (no Co-Authored-By headers)
  • Do NOT include phrases like "Generated with Claude Code" or "Created by Claude"
  • Do NOT mention AI or Claude anywhere in commits or PR descriptions

PR Title Format

Use active voice with a present-tense verb:

GoodBad
Add user authenticationAdded user authentication
Fix memory leak in cacheFixing memory leak
Update dependencies to latestDependency updates
Remove deprecated API endpointsRemoved deprecated API
Refactor database connection poolDatabase refactoring

Pattern: <Verb> <what> [to/in/for <context>]

Common verbs: Add, Fix, Update, Remove, Refactor, Implement, Improve, Replace, Enable, Disable

PR Description Structure

## Why

[Explain the motivation for this change. What problem does it solve? What feature does it enable?]

## Approach

[Explain why this implementation was chosen over alternatives. What trade-offs were considered?]

## How it works

[Describe the technical implementation. How does the code achieve the goal?]

## Links

- [Ticket](url) or JIRA-123
- [Slack thread](url)

Step-by-Step Process

1. Gather Context

Before creating the PR, understand what's being changed:

# See all commits on this branch vs main
git log main..HEAD --oneline

# See the full diff
git diff main...HEAD

# Check current branch name
git branch --show-current

Ask the user or search for:

  • Jira/ticket numbers (look in commit messages or branch name)
  • Related Slack conversations
  • Fusion run URLs
  • GCS paths for data or artifacts

3. Draft the PR

gh pr create --title "Add feature X to service Y" --body "$(cat <<'EOF'
## Why

[Motivation here]

## Approach

[Implementation rationale here]

## How it works

[Technical details here]

## Links

- [Ticket](url)
EOF
)"

Example

Branch: feature/add-retry-logic Commits: Adds exponential backoff retry to HTTP client

Title: Add exponential backoff retry to HTTP client

Description:

## Why

HTTP requests to external services occasionally fail due to transient network issues. Without retry logic, these failures cascade to users as errors.

## Approach

Chose exponential backoff over fixed-interval retry to avoid thundering herd problems during partial outages. Used a max of 3 retries with jitter to spread out retry attempts.

## How it works

Wraps the existing HTTP client with a retry decorator. On 5xx responses or network errors, waits `2^attempt * 100ms + random(0-50ms)` before retrying. Logs each retry attempt for observability.

## Links

- [PROJ-1234](https://jira.example.com/browse/PROJ-1234)
- [Slack discussion](https://slack.com/archives/...)

CLI Commands

# Create PR interactively
gh pr create

# Create with title and body
gh pr create --title "Add X" --body "Description here"

# Create as draft
gh pr create --draft --title "Add X" --body "..."

# Create with specific base branch
gh pr create --base develop --title "Add X" --body "..."

# Create and immediately open in browser
gh pr create --title "Add X" --body "..." --web

Validation Checklist

Before creating the PR, verify:

  • Title uses active voice with present-tense verb
  • Description has Why, Approach, and How sections
  • All relevant links are included
  • No AI/Claude attribution anywhere
  • No Co-Authored-By headers in commits

Score

Total Score

50/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon