pull-request-conventions

Included with Lifetime

$97 forever

Use when creating or merging pull requests - provides branch naming, PR title format, and description requirements for consistent PR workflows

General

What this skill does


# Pull Request Conventions

## Branch Naming Convention

**Format:** `<type>/<issue-number>-<description>` or `<type>/<description>`

**Types** (must match conventional commit types):

- `feat` - New feature
- `fix` - Bug fix
- `docs` - Documentation only
- `chore` - Maintenance tasks
- `refactor` - Code restructuring
- `test` - Adding or updating tests
- `build` - Build system changes
- `ci` - CI configuration
- `perf` - Performance improvements
- `style` - Code style changes (formatting, etc.)

**Examples:**

- `feat/123-user-auth`
- `fix/login-error`
- `docs/api-guide`
- `refactor/simplify-validation`

## PR Title Convention

PR titles must follow Conventional Commits format.

**Format:** `<type>[optional scope]: <description>`

**Why:** PR title becomes the squash merge commit message on main.

**Examples:**

- `feat(auth): add JWT validation`
- `fix: resolve login error`
- `docs(api): update endpoint documentation`

## Deriving PR Title

**Primary source: commits.**
The PR title should reflect what the changes actually accomplish, not just the branch name.

**Process:**

1. Review commit history to understand the changes
2. Identify the primary type (`feat`, `fix`, `refactor`, etc.)
3. Summarize the changes concisely
4. Add scope if clearly scoped to a specific area

**Branch name as fallback:**
If starting from branch name (e.g., when branch already exists), use it as a hint:

1. Extract type from prefix: `feat/...` → `feat`
2. Remove issue number if present: `feat/123-user-auth` → `user auth`
3. Convert hyphens to spaces

**Scope is optional** - add when the change is clearly scoped to a specific area:

- `feat/auth-jwt-validation` → `feat(auth): jwt validation`
- `fix/login-error` → `fix: login error` (no obvious scope)

**Important:** The branch name may diverge from actual changes during development.
Always verify the title accurately reflects what the PR contains.

## PR Description Requirements

**Foundational principle: Description must be 100% accurate.**

### Required Sections

```markdown
## Summary

<1-3 bullet points describing what changed and why>

## Test plan

<How to verify the changes work>
```

### Accuracy Rules

The description must reflect the **final state** of changes, not the journey:

- If code was added then removed: don't mention it
- If approach changed mid-development: describe final approach only
- If features were split to other PRs: don't reference them

### Common Red Flags

When reviewing PR descriptions, watch for:

- Mentions features that were removed
- Describes approach that was changed
- References safeguards that were removed
- Contains code examples that don't match final implementation

Files: 1

Size: 2.8 KB

Complexity: 6/100

Category: General

Source: https://github.com/zookanalytics/claude-devcontainer/tree/main/packages/git-workflow/skills/pull-request-conventions

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts