Format de description de PR

VérifiéSûr

Fournit le format de description de PR et les exigences de flux de travail pour les pull requests GitHub.

Spar Skills Guide Bot
DeveloppementDébutant
26/07/2026
Claude Code
#pull-requests#github#gh-cli#workflow#japanese

Recommandé pour

Synthèse automatique

Impose un format de description de pull request GitHub (概要 / 変更の背景 / 変更詳細) et un flux de travail en draft via la CLI gh, avec rédaction en japonais au style neutre.

Points forts

  • Fournit un gabarit clair en trois sections (résumé, contexte, détails des changements)
  • Vérifie d'abord l'existence d'un template de PR dans le dépôt et le respecte
  • Encadre le cycle de vie de la PR : création en draft, passage en ready, mise à jour du corps à chaque commit

Limites

  • Suppose que la CLI gh soit installée et authentifiée sur le dépôt
  • Impose le japonais en forme neutre (だ/である), ce qui ne convient pas à tous les dépôts
  • Ne couvre ni la revue de code, ni les conventions de commit, ni les labels
Quand l'utiliser

À utiliser lorsqu'il faut rédiger ou mettre à jour la description d'une pull request GitHub de façon structurée et cohérente.

Quand l'éviter

À éviter sur des dépôts dont les descriptions de PR sont attendues dans une autre langue ou un autre format imposé.

Analyse de sécurité

Sûr
Score qualité88/100

The skill only instructs using GitHub CLI commands (gh pr create, gh pr ready, gh pr edit) for legitimate PR management. No destructive, exfiltrating, or obfuscated actions are present. Although it uses network-capable commands, the purpose is benign and standard developer workflow.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Create a draft PR
Create a draft PR for my current branch with a Japanese description in the What/Why/How format. If the repo has a PR template, use that instead.
Refresh the PR body
I just pushed two more commits to this PR — update the description so it matches the current state of the changes.
Mark PR ready
The draft PR looks good now, mark it as ready for review.

name: pr-description-format description: Provides PR description format and workflow requirements for GitHub pull requests. Use this skill when creating PRs or using 'gh pr create'.

PR Description Format

Instructions

Important Notes

  • Do not use roleplay; use normal professional tone.
  • If "Why" is unclear, ask user before creating PR.
  • PR descriptions should be written in Japanese using plain form (だ/である/体言止め style), not polite form (です/ます style).
  • Always check if the repository has a PR template first (common locations: .github/PULL_REQUEST_TEMPLATE.md, .github/pull_request_template.md, PULL_REQUEST_TEMPLATE.md, docs/PULL_REQUEST_TEMPLATE.md). If a template exists, use that template instead of the format provided below.

Workflow Requirements

  1. Always start with Draft PR: gh pr create --draft
  2. Switch to open only when requested: gh pr ready
  3. Update description on new commits: gh pr edit --body to reflect current state

Examples

Format: What / Why / How

## 概要
[変更内容の簡潔な要約]

## 変更の背景
[なぜこの変更が必要だったか]

## 変更詳細
- [具体的な変更内容と実装の詳細]

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/pr-description-format-ms1aw5i4/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/pr-description-format-ms1aw5i4' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/pr-description-format-ms1aw5i4/download' --output '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md.part' && mv '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md.part' '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md' && test -s '.skill-downloads/pr-description-format-ms1aw5i4/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/pr-description-format' && cp -R '.skill-downloads/pr-description-format-ms1aw5i4' '.claude/skills/pr-description-format'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/pr-description-format-ms1aw5i4'

openskills read 'pr-description-format-ms1aw5i4'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/pr-description-format-ms1aw5i4/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires