Communitygithub.com

geekjourneyx/readme-generator

Génère des README.md de qualité portfolio pour projets GitHub. Idéal pour "écris mon README", "génère un README", "optimise mon README", "bonnes pratiques README", "page d'accueil projet", "README open source", "README infographie", "couverture README", "génère une image README avec Codex Image Gen / gpt-image-2".

Qu'est-ce que readme-generator ?

Ce skill AI génère des fichiers README.md de niveau portfolio pour des projets GitHub. Il va au-delà des simples templates : il lit d'abord le projet, en extrait l'histoire, puis construit un récit clair et visuel. Il génère jusqu'à deux assets visuels de haute qualité (bannière et illustration des fonctionnalités) en utilisant principalement Codex Image Gen, avec un repli sur HTML vers PNG si nécessaire. Le skill s'appuie sur des principes de conception stricts (éclairage cinématographique, palette sobre, lisibilité garantie) et une grille d'évaluation pour garantir que chaque README atteigne au moins 90 points. Il produit un README structuré, des suggestions pour la description et les topics GitHub, ainsi que des recommandations optionnelles pour la mise à jour via l'outil en ligne de commande gh. Il est conçu pour des agents comme Claude Code, Cursor ou Codex.

Compatible avec✓Claude Code✓Codex CLI~Cursor
npx skills add geekjourneyx/readme-generator

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Aperçu

Depuis le README du skill

License: MIT
readme-generator preview
readme-generator preview

Documentation

Générateur de README GitHub

Le README est la première page de portfolio d'un projet. Ce n'est ni une table des matières d'un manuel, ni un inventaire de fonctionnalités. Il doit répondre rapidement à trois questions :

  1. Qu'est-ce que c'est ?
  2. Pourquoi ça mérite l'attention ?
  3. Comment commencer à l'utiliser ?

Ce Skill a pour objectif de générer des README notés 100/100 : clairs, esthétiques, sobres, crédibles, permettant au projet d'être compris comme une œuvre complète.


Principes fondamentaux

Le README est une porte d'entrée de confiance et un point d'accès au projet, pas une documentation exhaustive. Il doit permettre à une personne ouvrant le dépôt pour la première fois de prendre une décision rapide :

  1. Ce projet résout-il un problème ?
  2. Est-il pertinent pour moi ?
  3. Puis-je l'exécuter, l'installer ou en savoir plus immédiatement ?

Les projets open source avec plus de 10k étoiles ne gagnent pas par la quantité d'informations, mais par la clarté du premier écran, un chemin d'accès direct, des entrées de documentation crédibles et des informations communautaires sobres. Les images, badges, informations sur l'auteur et la philosophie de conception ne sont que des aides ; dès qu'ils ralentissent la compréhension, ils deviennent du bruit.

Le compromis fondamental de ce Skill : le README raconte d'abord le projet, puis l'embellit ; le visuel sert la compréhension, il ne la remplace pas.


Critères de qualité

Utilisez la grille d'évaluation suivante pour contraindre toutes les sorties :

DimensionPointsCritère
Compréhension en 15s25Le premier écran permet de comprendre le nom du projet, sa valeur et son public cible
Histoire du projet20Pas une énumération de fonctionnalités, mais le contexte, la motivation et les résultats
Expression visuelle20Les images ressemblent à des œuvres, pas à des captures d'écran de processus
Démarrage rapide15Chemin d'installation et d'utilisation court, clair et reproductible
Produit crédible10Présentation de résultats réels, des limites des capacités ou des exemples
Sobriété et réduction du bruit10Suppression des répétitions, des slogans, des explications excessives et des éléments décoratifs

Un README en dessous de 90 points n'est pas livré ; supprimez d'abord le bruit, amplifiez l'essentiel, réorganisez le récit.

Structure de base des projets très étoilés

Apprenez par défaut la structure des projets open source très étoilés :

  • Nom du projet + proposition de valeur en une phrase.
  • Quelques badges essentiels, pas d'accumulation décorative.
  • Démarrage rapide ou entrée de documentation placée en haut.
  • Exemples uniquement s'ils réduisent le coût de démarrage.
  • Contributions, communauté, sécurité, licence : clairs et concis.
  • Captures d'écran pour les projets UI/produit ; peu ou pas d'images pour les bibliothèques, SDK, infrastructures.

N'écrivez pas un README comme un manifeste de design, un manuel complet, un mur de fonctionnalités, une carte de visite sociale ou un rapport de workflow interne.


Principes de conception

À respecter impérativement

  • Le H1 doit être le nom officiel du projet, immédiatement suivi d'une proposition de valeur.
  • Le README commence par la valeur du projet, puis les détails d'installation.
  • Chaque image exprime un seul point fort, mais doit servir de carte de visite du projet : le nom et le positionnement doivent être visibles en un coup d'œil.
  • Par défaut, deux images maximum : une bannière et une image des fonctionnalités principales.
  • GitHub réduit la taille des images ; le texte principal doit être conçu avec une taille de police digne d'une affiche.
  • Les descriptions des fonctionnalités doivent être spécifiques mais pas exagérées ; utilisez les résultats pour prouver, pas l'autosatisfaction.
  • Restez concis pour l'auteur et la licence ; pas d'accumulation de cartes de visite sociales.

À éviter impérativement

  • Titres en art ASCII.
  • Emojis décoratifs dans les titres ou les tableaux d'auteurs.
  • Grands paragraphes vides du type "nous sommes très professionnels".
  • Plus de 6 petites cartes entassées dans une seule image.
  • Diagrammes de flux remplis d'étapes, de commandes et de petites notes.
  • Utiliser un troisième diagramme de flux comme production par défaut ; le mode de fonctionnement est souvent mieux expliqué en texte.
  • Utiliser Image Gen comme outil de mise en page de longs textes.
  • Écrire le README comme un manuel produit complet ; la documentation détaillée doit aller dans docs/.

Flux global

Phase 0    Lecture du projet et identification des modèles
Phase 1    Extraction de l'histoire du projet
Phase 2    Choix du mode de génération visuelle
Phase 3    Génération des assets visuels de qualité portfolio
Phase 4    Assemblage du README
Phase 5    Suggestions de métadonnées GitHub
Phase 6    Validation et livraison

Phase 0 : Lecture du projet et identification des modèles

Lisez d'abord le projet, ne passez pas directement à un template.

Vérifications :

ls
find . -maxdepth 2 -type f | sed 's#^\./##' | sort | head -80

Lecture prioritaire :

  • README.md
  • package.json / pyproject.toml / go.mod / Cargo.toml
  • docs/
  • Fichiers d'entrée principaux
  • Exemples, captures d'écran, fichiers de démonstration

Évaluez le contexte et le budget visuel :

ContexteMéthode d'évaluationStratégieLimite d'images
Nouveau READMEPas de README, ou README très courtGénération complète, mais avec un chemin court1-2
Mise à niveau du READMEREADME existant avec contenu valideConserver le contenu unique, réécrire la structure et le premier écran0-2
Renforcement portfolioL'utilisateur insiste sur l'esthétique, l'histoire, la présentationPriorité au récit et à la couverture2
Mode documentation pureSDK, bibliothèque, outil backend, infrastructurePeu d'images, priorité à l'installation, l'API et l'entrée de documentation0-1
Présentation UI / produitInterface, captures d'écran, démo, résultats visuelsUtilisez des résultats réels ou une couverture pour aider à la compréhension1-2

Lors de la mise à niveau d'un README existant, ne supprimez pas le contenu clé déjà présent. Extrayez d'abord le contenu à conserver, puis réorganisez.

Revue de réduction du bruit

Avant d'écrire le README, marquez les éléments à déplacer ou supprimer :

ContenuTraitement par défaut
Grille d'évaluation de design, principes de travail, méthodologie internePlacez dans SKILL.md ou docs/, pas dans le README
Arborescence de fichiers générée, variables de template, détails de scriptConservez uniquement si l'utilisateur a besoin de documentation de développement
Troisième diagramme de fluxSupprimez, remplacez par 2-4 lignes de texte ou une courte liste
Trop de liens sociauxGardez uniquement GitHub / site principal, etc.
Liste de fonctionnalités trop vagueFusionnez en 3 capacités orientées résultats
Long contexte avant l'installationRaccourcissez, avancez le démarrage rapide

Phase 1 : Extraction de l'histoire du projet

Collectez ou déduisez 7 champs :

ChampDescription
project_nameNom officiel du projet
taglineProposition de valeur en une phrase, courte et percutante
originContexte d'émergence du projet : pourquoi il est nécessaire
audienceQui l'utilisera
promiseCe qu'il apporte à l'utilisateur comme résultat
proofCapacités réelles, captures d'écran, sorties, exemples, métriques
startChemin d'accès le plus court

Ne posez pas trop de questions. Déduisez directement à partir du projet quand c'est possible ; ne demandez à l'utilisateur que si cela affecte la précision du récit.

Structure narrative recommandée

Nom du projet
Proposition de valeur en une phrase
Couverture visuelle (selon le type de projet)

Qu'est-ce que c'est
Pourquoi en avez-vous besoin
Ce que vous obtiendrez
Démarrage rapide
Exemple ou résultat
Mode de fonctionnement (texte, pas d'image par défaut)
Installation
Licence
Auteur

Si le projet est un outil, une bibliothèque ou une infrastructure, placez le « Démarrage rapide » après « Pourquoi en avez-vous besoin ». L'ordre du README doit servir l'action du lecteur, pas l'exhaustivité du template.


Phase 2 : Choix du mode de génération visuelle

Il existe deux types d'images pour le README :

  1. Couverture portfolio : transmet le caractère, le thème, les points de mémorisation.
  2. Diagramme d'explication structurelle : transmet les étapes, les capacités, les comparaisons, les flux.

Choisissez le mode en fonction de l'intention de l'utilisateur :

ModeContexte d'applicationStratégie d'image
portfolioRecommandé par défaut, pour les projets nécessitant une présentation complète1 couverture + 1 image des fonctionnalités clés
clean-docSDK, bibliothèque, outil backend, infrastructure sérieuse0-1 image, priorité au démarrage rapide et aux exemples
visual-storyOutils IA, outils de design, produits indépendants, présentation de travaux2 images maximum, Codex Image Gen pour les points de mémorisation
structuredL'utilisateur demande explicitement des infographies, des diagrammes de comparaison ou des flux1-2 affiches HTML/CSS, garantissant la précision du texte

Par défaut, déterminez d'abord le type de projet ; n'appliquez pas portfolio de force. La priorité de génération des assets visuels est fixe :

  1. Codex Image Gen Skill : utilisez en priorité la capacité de génération d'images intégrée à Codex.
  2. Léger : convertissez les images d'affichage du README en WebP en priorité, puis écrivez le chemin de référence dans le README.
  3. HTML to PNG fallback : uniquement si Image Gen est indisponible, si les sorties ne correspondent pas aux exigences, ou si l'utilisateur demande explicitement un texte structuré précis, dégradez-vous vers une capture d'écran de template HTML/CSS.

N'utilisez pas la capture d'écran HTML comme chemin par défaut. C'est un filet de sécurité fiable, pas une solution visuelle de premier choix.


Phase 3 : Génération des assets visuels de qualité portfolio

La sortie par défaut utilise deux noms de fichiers stables :

assets/banner.webp
assets/features.webp

Ainsi, les chemins de référence dans le README sont stables, que les images proviennent de Codex Image Gen ou du fallback de capture d'écran HTML.

Rôle des images

ImageObjectifMéthode recommandée
banner.webpCarte de visite du projet, établit le nom, le positionnement et les points de mémorisationCodex Image Gen en priorité
features.webpImage de propagation des capacités clés, des résultats ou des processus nécessairesCodex Image Gen en priorité ; fallback HTML pour la précision du texte

Ne générez pas workflow.png ou workflow.webp par défaut. Si l'utilisateur demande explicitement un diagramme de flux, fusionnez le contenu du flux dans features.webp ou placez-le dans le texte, sans ajouter de troisième image.

Style visuel par défaut

Tous les assets visuels du README adoptent par défaut le même style :

Fond noir, minimaliste, éclairage cinématographique, contraste élevé, grands espaces vides, faible luminosité, palette blanche/grise/or chaud, aspect de couverture de magazine haut de gamme.
Qualité de l'image : fond noir profond #050505, grain de papier, faible profondeur de champ, brume volumétrique, fine lumière de contour, reflets métalliques sélectifs.
Objectif de qualité : niveau de créativité d'un designer de projet 10k étoiles.

Contraintes de design :

  • Fond principal : #050505 (noir profond).
  • Couleurs : uniquement blanc, gris, or chaud ; n'introduisez pas de dégradés arc-en-ciel, de néon violet-bleu ou de couleurs décoratives saturées.
  • Utilisez de grands espaces vides et un éclairage localisé, pas une accumulation d'éléments.
  • Les images doivent contenir un texte de grande valeur, servant à la propagation et au positionnement, pas à de longues explications.
  • Moins il y a de texte, plus c'est fort : chaque image ne conserve que les informations que le lecteur devrait encore retenir après avoir quitté le README.
  • Pas de paragraphes, de commandes, de tableaux, d'empilements de numéros de version ou de descriptions denses.

Stratégie de texte pour la carte de visite du projet

Par défaut, utilisez une « image de type carte de visite de projet », pas une image d'ambiance pure.

ImageTexte recommandéLimite
banner.webpNom du projet + une phrase de positionnement + 1-3 courtes étiquettes18 mots anglais ou 28 caractères chinois
features.webp2-3 phrases de résultat, avec éventuellement un court titre2-5 mots par phrase

Un bon texte doit ressembler à un titre de couverture, pas à un manuel :

  • Le nom du projet doit être clair, placé de préférence dans banner.webp.
  • La phrase de positionnement parle de résultats, pas de slogans, par exemple « Portfolio-grade README design for open source projects ».
  • Les étiquettes ne doivent contenir que les mots ayant la plus grande valeur de recherche et de mémorisation, par exemple Story, Visual, Signal.
  • Le chinois peut être utilisé, mais en petite quantité ; les noms de projet en anglais et les courtes étiquettes en anglais sont généralement plus stables.
  • Si Image Gen écrit mal le texte, réessayez une fois ; si ce n'est toujours pas précis, conservez l'image de fond d'Image Gen et utilisez le fallback HTML/CSS pour le texte précis.
  • Ne sacrifiez pas la précision du nom du projet et du positionnement pour une « génération 100% IA ».

Seuil de taille de police

Pour une conception en 1920×1080 :

ÉlémentTaille de police minimale
Titre principal92px
Titre principal chinois80px
Titre de grande carte48px
Texte de description28px
Étiquettes auxiliaires22px
Pied de page20px

N'utilisez pas de texte en dessous de 18px. Il deviendra illisible après le redimensionnement par GitHub.

Les productions de Codex Image Gen doivent seulement conserver le ratio 16:9 et être suffisamment nettes ; ne rééchantillonnez pas de force une bonne image à 1920×1080 pour le plaisir. Les images d'affichage du README sont prioritaires en WebP ; 1920×1080 est la taille de template pour le fallback HTML vers PNG.

Fallback HTML vers PNG

À utiliser uniquement si Image Gen est indisponible, si l'utilisateur demande un texte structuré précis, ou si la sortie d'Image Gen ne passe pas la validation :

node scripts/gen_infographic.mjs /tmp/readme-banner.html assets/banner.png 1920 1080
node scripts/gen_infographic.mjs /tmp/readme-features.html assets/features.png 1920 1080
node scripts/convert_webp_assets.mjs assets/banner.png assets/banner.webp assets/features.png assets/features.webp

Les templates proviennent de :

templates/banner.html
templates/features.html

Variables de template :

{{PROJECT_NAME}}
{{TAGLINE}}
{{PRIMARY_COLOR}}
{{CATEGORY}}
{{PLATFORM}}
{{LANGUAGE}}
{{VERSION_INFO}}
{{TECH_CARDS}}
{{FEATURE_CARDS}}
{{FEATURE_COUNT}}

Structure des cartes :

  • {{TECH_CARDS}} : utilisé à droite de la couverture, 2-3 éléments recommandés, avec seulement une courte étiquette et une phrase de description.
  • {{FEATURE_CARDS}} : seulement 2-3 grandes cartes, la première peut être marquée featured.
  • Si un flux de travail doit être exprimé, utilisez les 3 phases de résultat de features.webp, sans ajouter de troisième image.

Méthode Codex Image Gen / gpt-image-2

Par défaut, appelez en priorité la capacité de génération d'images intégrée à Codex, n'écrivez pas de script API en dur dans le projet.

Contenu adapté à Image Gen :

  • Couverture du README.
  • Image d'ambiance du produit.
  • Visuels de portfolio.
  • Diagrammes conceptuels abstraits.
  • Extension de style à partir d'images existantes.

Contenu non adapté à Image Gen :

  • Diagrammes de flux précis.
  • Grands volumes de texte chinois ou de multiples paragraphes d'explication.
  • Commandes, versions, tableaux.
  • Texte long ou UI qui doit être précis mot pour mot.

Structure de prompt recommandée :

Use case: productivity-visual
Asset type: GitHub README visual asset, 16:9
Project: <project_name>
Story: <origin + promise>
Visual direction: black background, minimalist, cinematic lighting, high contrast, large negative space, low brightness, premium magazine cover
Texture and lighting: #050505 deep black background, subtle paper grain, shallow depth of field, volumetric haze, thin rim light, selective metallic highlights
Palette: white, gray, warm gold only
Composition: one strong visual idea, restrained, spacious, no dense UI
Quality bar: 10k-star designer portfolio quality
Text policy: include only high-value name-card text. Use the exact project name, one short positioning line, and optional 1-3 short labels. No paragraphs, commands, tables, tiny captions, or decorative text.
Avoid: emoji, clutter, fake interface text, tiny labels, generic gradients, bright neon, overdesigned dashboards

Si Image Gen n'est pas disponible, ne peut pas être appelé, ou si la sortie présente des erreurs de texte ou des écarts de style, réessayez une fois avec un prompt textuel plus court ; si ce n'est toujours pas précis, revenez au processus de fallback HTML vers PNG pour le texte précis.

Allègement des images

Les images d'affichage du README utilisent par défaut le format WebP. Le WebP est généralement plus adapté au chargement dans un README que le PNG ; le PNG n'est utilisé que comme produit intermédiaire du fallback de capture d'écran HTML, pour les images transparentes ou lorsqu'une conservation sans perte est nécessaire.

Commande par défaut :

npm run webp

Si le projet ne dispose pas d'un script de conversion WebP, utilisez en priorité cwebp, sips ou un outil léger disponible. N'introduisez pas de dépendances lourdes pour la conversion. Si la conversion est impossible, conservez le PNG en expliquant la raison.

Vérification visuelle

Après chaque génération d'image, vérifiez :

  • L'image reste lisible après réduction à la largeur d'affichage du README GitHub.
  • Une image ne raconte qu'un seul point fort.
  • Pas d'accumulation de petits caractères.
  • Le nom du projet et la phrase de positionnement sont visibles en un coup d'œil.
  • Pas de fautes d'orthographe, de caractères illisibles ou de faux texte dans l'image.
  • Pas de décorations excessives.
  • Le style visuel est cohérent avec l'histoire du projet.
  • Les images générées par IA ne contiennent pas de texte erroné ou de filigranes superflus.
  • L'image compressée reste nette, sans bandes de couleur évidentes, artefacts de bruit destructeurs ou bords de texte flous.

Phase 4 : Assemblage du README

Structure par défaut :

<div align="center">

# Nom du projet

**Proposition de valeur en une phrase**

<img src="assets/banner.webp" alt="[Nom du projet] — [Proposition de valeur]" width="100%">

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

</div>

---

## Qu'est-ce que c'est

[2-3 phrases pour expliquer le projet, son contexte et ses résultats.]

## Pourquoi en avez-vous besoin

[Parlez du vrai problème, ne dressez pas une liste d'anti-modèles.]

## Ce que vous obtiendrez

<img src="assets/features.webp" alt="[3 capacités clés]" width="100%">

## Mode de fonctionnement

[2-4 lignes pour expliquer le mode de fonctionnement ; ne rajoutez pas une troisième image par défaut.]

## Démarrage rapide

[Chemin exécutable le plus court.]

## Installation

[Dépendances et commandes d'installation.]

## Licence

[MIT](./LICENSE)

## À propos de l'auteur

[Informations concises sur l'auteur.]

Règles :

  • Ne dépassez pas 3 badges, sauf si le projet nécessite des indicateurs d'état.
  • Ne répétez pas la même liste de fonctionnalités après les images.
  • N'intégrez pas de force les « principes de conception », la « structure du projet » ou le « contenu généré » dans le README ; ne conservez que les parties utiles au lecteur.
  • Ne mettez pas de troisième image de workflow par défaut ; deux images suffisent pour le portfolio et les informations clés.
  • S'il y a des détails, placez-les dans docs/, le README ne servant que d'entrée.

Phase 5 : Recommandations de métadonnées GitHub

La description du dépôt et les topics sont des points d'entrée pour la recherche GitHub, les associations Trending, les citations par l'IA et les jugements rapides humains. Ce ne sont pas du contenu du README ; ne les écrivez pas dans README.md ; fournissez-les uniquement comme suggestions indépendantes dans la réponse finale.

Objectifs fondamentaux

  • Description répond à : pour qui ce projet crée-t-il quel résultat ?
  • Topics répond à : dans quelles catégories de recherche ce projet doit-il apparaître ?
  • Quantité recommandée déterminée par la qualité du signal, pas par la quantité ; 7-9 de haute qualité sont souvent meilleurs que 20.
  • Équilibre Trending/SEO/GEO : couvrez les termes de recherche populaires tout en restant factuel pour faciliter les citations par l'IA.

Règles de génération de la description

Générez 3 candidats et notez chacun :

[Verbe] [résultat spécifique] pour [public cible] — [1-3 mots-clés précis]

Contraintes strictes :

  • Anglais prioritaire, ≤ 160 caractères.
  • Commence par un verbe : Design / Generate / Build / Create / Convert / Automate.
  • Inclut les 2-3 mots-clés les plus centraux du projet.
  • Pas d'emoji, de points d'exclamation ou d'adjectifs marketing.
  • N'écrivez pas de capacités qui ne sont pas étayées par les faits du projet.

Grille d'évaluation :

DimensionPointsCritère
Précision40Fidélité aux capacités réelles du projet
Valeur de recherche25Couvre les termes de recherche courants sur GitHub/Google
Citation par l'IA20Compréhensible directement par ChatGPT/Claude/Perplexity
Sobriété15Pas d'exagération ou de mots vides

Étoiles :

ScoreÉtoiles
90-1005 étoiles, recommandé pour utilisation
80-894 étoiles, utilisable mais peut être encore simplifié
70-793 étoiles, seulement pour les alternatives
< 70Non recommandé

Règles de génération des topics

Construisez d'abord un pool de candidats, puis sélectionnez les recommandations finales.

Sources de candidats :

  • Type de projet : agent-skill, cli-tool, developer-tools, documentation
  • Technologies clés : nodejs, playwright, codex, image-generation
  • Domaines d'application : readme, github-readme, open-source, portfolio
  • Tendances actuelles : agent IA, génération d'images, outils de développement, automatisation de la documentation
  • Mots-clés issus des fichiers réels du projet et du récit du README

Règles de sélection :

  • Recommandez 7-9 topics, pas plus de 10, sauf si le projet couvre plusieurs domaines distincts.
  • Les topics doivent être en minuscules, avec uniquement des lettres, des chiffres et des traits d'union.
  • Supprimez les mots trop vagues : software, tool, app, github, project, ai.
  • Supprimez les doublons : readme et github-readme peuvent coexister ; open-source et opensource ne doivent en garder qu'un.
  • N'ajoutez pas de topics irréalistes pour suivre les tendances.

Attribuez une note et une raison pour chaque topic :

ÉtoilesSignification
5 étoilesFortement pertinent, haute valeur de recherche, doit être inclus
4 étoilesPertinent et a de la valeur de découverte, peut être inclus
3 étoilesLien existant mais pas assez central
2 étoilesPertinence faible, généralement déconseillé
1 étoileBruit, à ne pas inclure

Format de sortie :

Recommandations de description GitHub :

1. ★★★★★ <description>
   Raison : ...

2. ★★★★☆ <description>
   Raison : ...

Recommandation finale : <description>

Recommandations de topics GitHub :

À ajouter :
- ★★★★★ github-readme — décrit précisément l'usage du projet
- ★★★★★ agent-skill — correspond à la forme du projet
- ★★★★☆ image-generation — à ajouter si le projet prend en charge Image Gen

Déconseillé :
- ★★☆☆☆ ai — trop vague, bruit de recherche
- ★★☆☆☆ github — trop vague, n'aide pas au classement

Mise à jour facultative avec gh CLI

Si l'utilisateur a installé gh, que le répertoire actuel est déjà un dépôt Git et que le remote GitHub peut être résolu, vous pouvez suggérer que l'Agent utilise gh repo edit pour mettre à jour. Ne mettez pas à jour sans autorisation ; vous devez d'abord montrer le contenu à exécuter et attendre la confirmation de l'utilisateur.

Vérifications :

gh --version
git remote -v

Format de commande suggéré :

gh repo edit OWNER/REPO \
  --description "<final-description>" \
  --add-topic topic-one \
  --add-topic topic-two \
  --add-topic topic-three

Si vous devez remplacer d'anciens topics, lisez d'abord les topics actuels, puis ne retirez que ceux explicitement déconseillés :

gh repo view OWNER/REPO --json description,repositoryTopics
gh repo edit OWNER/REPO --remove-topic old-topic --add-topic new-topic

Note : git ne peut pas mettre à jour les métadonnées du dépôt

La commande git ne peut pas modifier la description ou les topics d'un dépôt GitHub. Raison : la description et les topics sont des métadonnées de la plateforme GitHub, pas des commits, branches, tags ou configurations remote dans le dépôt Git.

git remote -v peut uniquement être utilisé pour identifier OWNER/REPO, pas pour mettre à jour les métadonnées.

Sans gh, fournissez uniquement les valeurs recommandées et laissez l'utilisateur les mettre à jour manuellement sur la page GitHub ; ne proposez pas de commandes alternatives complexes.

N'enregistrez pas ces recommandations dans le fichier README ; elles font partie des suggestions opérationnelles à l'utilisateur lors de la livraison.


Phase 6 : Validation et livraison

Avant la livraison, validez impérativement :

node --version
npm run showcase
file assets/banner.webp assets/features.webp
git status --short

Si vous avez modifié des templates ou des images réelles, vous devez régénérer les WebP et les ouvrir pour vérification.

Le rapport final doit seulement expliquer :

  • Ce qui a été modifié.
  • Quel est le résultat.
  • Quelles validations ont été effectuées.
  • S'il reste des points nécessitant une décision de l'utilisateur.

N'écrivez pas les détails d'implémentation et les processus longs à l'utilisateur.

Skills associés