Rédiger une description de PR memloom

VérifiéSûr

Rédiger des descriptions de PR concises et efficaces pour memloom, avec des règles de style et des pièges à éviter.

Spar Skills Guide Bot
DocumentationDébutant
04/08/2026
Claude Code
#pull-requests#writing#git#documentation#code-review

Recommandé pour

Synthèse automatique

Rédige le corps d'une pull request memloom selon un format court et strict : une phrase d'ouverture, des puces, et une liste des limites connues.

Points forts

  • Impose une structure minimale précise (phrase d'ouverture, section « What this adds », « Docs », « Known gaps »)
  • Fournit une liste explicite de ce qu'il ne faut jamais écrire, avec la raison de chaque exclusion
  • Donne des consignes de style concrètes : phrases courtes, présent de l'indicatif, pas de tirets cadratins
  • Inclut une étape de révision finale : relire et supprimer le tiers le plus faible

Limites

  • Fortement lié au dépôt memloom et à son flux /ship, peu réutilisable tel quel ailleurs
  • Ne couvre que la rédaction du corps de la PR, pas la création de la branche ni la revue
  • Les règles très prescriptives peuvent ne pas convenir aux projets qui documentent les tests ou les décisions de conception dans la PR
Quand l'utiliser

À utiliser dès qu'on ouvre ou modifie le corps d'une pull request dans le dépôt memloom, y compris depuis /ship.

Quand l'éviter

À éviter pour un projet qui exige des sections de vérification, de migration ou de justification des choix de conception dans ses pull requests.

Analyse de sécurité

Sûr
Score qualité88/100

This is a pure prose style guide for writing PR descriptions. It declares no tools, contains no commands, no network or filesystem instructions, and asks for no secrets. The 'Never include' table is editorial guidance about content to omit from public PR text, not an instruction to hide security-relevant information from reviewers, so it carries no meaningful execution risk.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Open a PR after shipping a feature
/ship the budget-and-run branch and write the PR description using the pr-description skill.
Rewrite a bloated PR body
Rewrite this PR body with the pr-description skill: it currently has a test results section, commit counts, and a design rationale paragraph.
Describe a feature with known gaps
Write the memloom PR body for the new backlog budgeting feature. It does not support pausing mid-run yet, and the docs page is updated.

name: pr-description description: Write the PR description for a memloom pull request. Use whenever opening or editing a PR body in this repo, including from /ship.

Writing a memloom PR description

A PR describes the change to someone who was not in the room. It is public. Write only what a reader needs to understand what shipped and what it cannot do.

Shape

<one sentence: what the feature does>

## What this adds
- bullets

## Docs
<one short paragraph, only if docs changed>

## Known gaps
- one sentence each

Nothing else unless the change genuinely calls for it.

Rules

Open with one sentence. Not two. The second sentence is always a summary of the bullets below, which the reader is about to read anyway.

Bullets, not tables. A table looks organised and reads slower. Bold the subject of each bullet and follow it with the fact.

Every line earns its place. Before keeping a sentence, ask what the reader does differently for having read it. If the answer is nothing, cut it.

Known gaps are one sentence each. State the limitation, not the history or the plan.

Never include

| Never | Why | |---|---| | A verification or testing section | Tests passing is the default. Nobody reads "686 tests green" | | What the code review found | Internal. The reader cares what the code does now, not what it did on Tuesday | | Migration or repair steps for a dev store | Internal. Say it in chat, never in public | | Commit counts, file counts, line counts | GitHub already shows these | | Rationale for design decisions | That belongs in code comments | | Anything phrased as effort or process | "This was tricky", "after several iterations" |

Voice

Plain short sentences. No em-dashes, no middle dots. Present tense. Name the thing rather than describing it: "Set a budget and a run keeps going until the backlog is clear" beats "a configurable budget mechanism has been introduced".

Before posting

Read it back and delete the weakest third. It will still say everything that matters.

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/write-a-memloom-pr-description-mse7in39/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/write-a-memloom-pr-description-mse7in39' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/write-a-memloom-pr-description-mse7in39/download' --output '.skill-downloads/write-a-memloom-pr-description-mse7in39/SKILL.md.part' && mv '.skill-downloads/write-a-memloom-pr-description-mse7in39/SKILL.md.part' '.skill-downloads/write-a-memloom-pr-description-mse7in39/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/write-a-memloom-pr-description-mse7in39/SKILL.md' && test -s '.skill-downloads/write-a-memloom-pr-description-mse7in39/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/pr-description' && cp -R '.skill-downloads/write-a-memloom-pr-description-mse7in39' '.claude/skills/pr-description'

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/write-a-memloom-pr-description-mse7in39'

openskills read 'write-a-memloom-pr-description-mse7in39'

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/write-a-memloom-pr-description-mse7in39/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