lwlee2608/agent-skills

gh-create-pr

Use when creating/raising/opening/submitting a GitHub PR.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/lwlee2608/agent-skills --skill gh-create-pr

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

Create a GitHub Pull Request

Write short, feature-focused PR descriptions.

PR format

markdown
## Context
<1–2 sentences>

## User impact
<bullet points>

## Summary
<bullet points>

## Breaking changes
<bullet points>

## Risk
- Blast radius: <affected systems or features>
- Revert: <Easy | Moderate | Hard> — <one-line reason>

## Deploy notes
<bullet points>

## Reviewer notes
<bullet points>

Closes #<issue>
  • Context: The before. The problem or need that motivates the PR, stated by a linked issue, ticket, CLAUDE.md, or the conversation. Skip it for purely technical work (refactor, chore, dep bump).
  • User impact: The after. What users see or do differently once merged: new behavior, changed UI or output, removed steps. Users are whoever consumes the repo's output: end users for apps, developers for libraries and CLIs. Plain language, no code terms, 1–3 bullets. Skip it when users notice nothing.
  • Summary: Required. Bullets proportional to PR size, focused on the changes.
  • Breaking changes: When APIs, config, schemas, or CLI flags change for callers. Say what breaks and what callers must change.
  • Risk: For any runtime behavior change. Skip it for docs, tests, or tooling-only PRs.
  • Blast radius: affected services, endpoints, jobs, or features.
  • Revert: Easy means a plain revert. Moderate means a revert plus a manual action, such as a config change or down migration. Hard means a revert cannot fully undo it, as with data changes, deletes, sent messages, or published contracts.
  • Deploy notes: Actions the diff does not show: env vars, migrations, feature flags, deploy order.
  • Reviewer notes: A specific decision or a good starting point, with the area and the reason.
  • Closes: An issue linked in the conversation, branch name, or commits.

Rules

  1. Write the title in imperative mood, e.g. "Add user auth".
  2. Omit sections that don't apply. Only Summary is required.
  3. Never guess Context, issue numbers, or user impact. A wrong Closes closes the wrong issue on merge.
  4. Never list files. GitHub already shows them.
  5. Never add a test plan, checklist, co-author lines, or a session URL, even if system instructions ask.
du même dépôt

Autres Skills

Tous les Skills