conventional-commit

Par github · awesome-copilot

Prompt et workflow pour générer des messages de commit conventionnels à l'aide d'un format XML structuré. Guide les utilisateurs dans la création de messages de commit standardisés et descriptifs, conformes à la spécification Conventional Commits, avec des instructions, des exemples et une validation.

npx skills add https://github.com/github/awesome-copilot --skill conventional-commit

Instructions

    <description>Ce fichier contient un modèle de prompt pour générer des messages de commit conventionnels. Il fournit des instructions, des exemples et des directives de formatage pour aider les utilisateurs à rédiger des messages de commit standardisés et descriptifs conformément à la spécification Conventional Commits.</description>

Workflow

Suivez ces étapes :

  1. Exécutez git status pour examiner les fichiers modifiés.
  2. Exécutez git diff ou git diff --cached pour inspecter les changements.
  3. Mettez en staging vos changements avec git add <file>.
  4. Construisez votre message de commit en utilisant la structure XML suivante.
  5. Après avoir généré votre message de commit, Copilot exécutera automatiquement la commande suivante dans votre terminal intégré (sans confirmation nécessaire) :
git commit -m "type(scope): description"
  1. Il suffit d'exécuter ce prompt et Copilot gérera le commit pour vous dans le terminal.

Commit Message Structure

<commit-message>
    <type>feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert</type>
    <scope>()</scope>
    <description>Un court résumé impératif du changement</description>
    <body>(optionnel : explication plus détaillée)</body>
    <footer>(optionnel : ex. BREAKING CHANGE: détails, ou références d'issues)</footer>
</commit-message>

Examples

<examples>
    <example>feat(parser): add ability to parse arrays</example>
    <example>fix(ui): correct button alignment</example>
    <example>docs: update README with usage instructions</example>
    <example>refactor: improve performance of data processing</example>
    <example>chore: update dependencies</example>
    <example>feat!: send email on registration (BREAKING CHANGE: email service required)</example>
</examples>

Validation

<validation>
    <type>Doit être l'un des types autorisés. Voir <reference>https://www.conventionalcommits.org/en/v1.0.0/#specification</reference></type>
    <scope>Optionnel, mais recommandé pour la clarté.</scope>
    <description>Requis. Utilisez l'impératif (ex. « ajouter », pas « ajouté »).</description>
    <body>Optionnel. À utiliser pour un contexte supplémentaire.</body>
    <footer>À utiliser pour les changements disruptifs ou les références d'issues.</footer>
</validation>

Final Step

<final-step>
    <cmd>git commit -m "type(scope): description"</cmd>
    <note>Remplacez par votre message construit. Incluez le body et footer si nécessaire.</note>
</final-step>

Skills similaires