Nettoyeur de dépôt
Rendez le but, la preuve et la première action utile d'un bon projet faciles à trouver. Améliorez la surface du dépôt tout en préservant le comportement de l'application.
1. Établir la brève
- Identifiez le dépôt, le public, le résultat souhaité, la langue, et décidez entre audit ou implémentation. Réutilisez l'autorisation déjà donnée.
- Lisez les instructions applicables, le README, les guides liés, la licence, les manifestes de paquet/compétence, les exemples, les ressources et les métadonnées GitHub actuelles. Inspectez la source uniquement si nécessaire pour vérifier les affirmations et les commandes.
- Inspectez l'arbre de travail et préservez les modifications non liées, la licence existante et l'attribution. Gardez la visibilité inchangée, sauf si un changement de visibilité est explicitement autorisé.
- Posez des questions ciblées sur les faits manquants ou les choix importants : public, branding conflictuel, accès indisponible, installation incertaine, ou un rebranding significatif. Résolvez les choix de mise en page courants à partir du projet. Continuez le travail indépendant en attendant ; n'inventez pas de faits pour éviter de demander.
- Utilisez assets/repo-brief.md si une brève de travail est utile ; ne l'ajoutez pas à chaque dépôt cible.
2. Auditer le parcours du lecteur
Lisez references/audit-and-validation.md. Tracez découverte → premier écran → preuve → installation → premier succès → aide plus approfondie.
Listez les quelques écarts les plus importants avec preuve et priorité. Séparez les problèmes factuels des choix esthétiques. Incluez l'encombrement à supprimer. Distinguez les informations manquantes des informations indisponibles pour vos outils. Pour un travail d'audit uniquement, renvoyez les résultats et des recommandations concrètes sans modifier les fichiers ou les paramètres.
3. Construire une présentation cohérente
Lisez references/readme-and-visuals.md. Par défaut, utilisez le style de document natif GitHub, les badges plats standard, les liens de navigation ordinaires et les preuves spécifiques au projet. Ne réutilisez pas l'esthétique du profil personnel d'un auteur sauf si demandé. Lisez references/readme-patterns.md lorsque vous choisissez une structure ou apprenez de dépôts de référence. Choisissez une direction adaptée au projet, puis implémentez le plus petit ensemble complet de ressources et de documents qui le rend compréhensible et utilisable.
- Menez avec une promesse spécifique, une preuve visuelle utile et une première action claire. Gardez les informations essentielles sous forme de texte réel.
- Ajoutez une bannière uniquement lorsqu'elle est utile ; préférez une tâche concrète, un résultat réel ou une démonstration utile à un branding décoratif ; capturez des captures d'écran à partir des résultats réels. Étiquetez avec précision les concepts, les montages, les reconstructions et les aperçus locaux.
- Ajoutez une rangée de badges sobre avec des destinations fonctionnelles et des affirmations étayées.
- Gardez l'exemple d'installation et d'utilisation le plus court et vérifié dans le README. Liez les guides de plateforme plus longs, le dépannage et les exemples sans les dupliquer.
- Organisez les documents publics et les ressources sans déplacer la source de l'application ni modifier le comportement d'exécution/construction. Mettez à jour les liens lors du déplacement de la documentation.
- Adaptez la profondeur de la documentation au projet. Supprimez le texte marketing générique, les slogans répétés, les tableaux de fonctionnalités forcés, les sections de remplissage, les murs de badges, les diagrammes décoratifs et les hiérarchies de dossiers vides. Conservez la voix spécifique du projet.
Pour les dépôts de compétences, vérifiez que le dossier installable inclut SKILL.md et chaque ressource référencée. Séparez ce paquet des documents marketing publics. Documentez les chemins de découverte exacts par hôte, les exemples d'invocation, les prérequis et les exigences d'outil. Indiquez si chaque route a été testée à l'exécution, vérifiée par rapport à la documentation de l'hôte, ou seulement utilisable manuellement. Ne déduisez pas un plugin, une inscription sur un marché ou un support universel d'agent à partir d'un simple dossier de compétence.
4. Améliorer la découvrabilité avec des métadonnées véridiques
Lisez references/github-discovery.md. Proposez un texte À propos concis, une page d'accueil utile réelle lorsqu'elle est disponible, des sujets étayés par des preuves et une ressource de prévisualisation sociale. Vérifiez les limites GitHub actuelles avant de les appliquer.
Appliquez les paramètres autorisés avec les outils appropriés, en préservant les valeurs existantes pertinentes. Si les outils ne disposent pas d'une opération, préparez les valeurs exactes et le lien des paramètres. Séparez appliqué, préparé et bloqué. Un fichier de métadonnées validé ou une image sociale ne configure pas GitHub. Ne modifiez jamais la visibilité, ne contactez pas d'autres personnes et ne soumettez pas d'annonces promotionnelles sans autorisation.
5. Vérifier et remettre
Validez le parcours du lecteur avec la référence d'audit : liens et ancres, images, démarrage rapide sûr, badges et compatibilité véridiques, bureau/mobile, clair/sombre, diff final et relecture des paramètres. Signalez explicitement les limites de l'outil ou du réseau. Enregistrez les ressources source afin que les mises à jour ultérieures restent pratiques.
Validez ou poussez uniquement lorsque cela est autorisé et suivez le workflow du dépôt cible. Confirmez la destination et la révision finale. Résumez les modifications, la vérification, les paramètres non appliqués et les quelques actions restantes. Ne promettez pas de trafic, d'étoiles, de classement ou de support non testé.