Synthèse automatique
Ce skill guide la préparation d'un projet GitHub pour une publication open source en s'assurant que tous les documents essentiels et fondations légales sont en place.
Points forts
- Approche structurée en 8 phases qui couvre sécurité, légal, documentation et durabilité.
- Inclut le nettoyage de l'historique Git pour éviter les fuites de secrets.
- Fournit des références détaillées et des modèles prêts à l'emploi.
Limites
- Nécessite une intervention manuelle de l'utilisateur pour certaines décisions (licence, gouvernance).
- Peut être excessif pour de petits projets ou des dépôts simples.
- Ne remplace pas un avis juridique professionnel pour les licences.
Utilisez ce skill lorsque vous souhaitez publier un projet sur GitHub de manière professionnelle et durable.
Ne l'utilisez pas pour des projets privés ou lorsque vous n'êtes pas prêt à appliquer les bonnes pratiques (ex. nettoyage de l'historique).
Analyse de sécurité
SûrThe skill is a guide for open-sourcing projects, using safe tools like file readers, git history analyzers, and documentation validators. It does not contain any destructive or exfiltrating instructions.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
I want to open source my GitHub project. Help me prepare it properly with all necessary files and checks.Can you scan my git history for any accidentally committed secrets or credentials before I publish my project?Help me add a code of conduct, contributing guide, and governance model to my project repo.name: open-source-best-practices description: Validates and prepares a GitHub project for open source release by ensuring all essential documentation and legal foundations are in place. Uses Git History Cleaner to identify and remove secrets, credentials, and sensitive data before publication. Use when you want to release a project publicly or harden an existing public repo. license: See LICENSE file in repository root metadata: author: AndreaGriffiths11 version: "1.0" allowed-tools: file_reader, file_writer, github_api, license_selector, documentation_validator, git_history_analyzer
Open Source Best Practices
This skill guides you through preparing your GitHub project for sustainable open source release.
How to Use This Skill
- See the full workflow in AGENTS.md - the complete phases and checklist
- Reference detailed guides in references/ folder:
- File requirements and structure
- License selection decision tree
- Security scanning and git history cleaning
- Governance framework
- Maintainer expectations
- GitHub Sponsors setup
- Template examples
Quick Overview
The workflow has 8 phases (do them in order; Phase 1 isn't optional):
- Security First - Clean your git history using Git History Cleaner
- Legal & Ownership - Choose license, verify ownership, clarify admin rights
- Community Foundations - Add Code of Conduct, governance, decision-making
- Documentation & Onboarding - README, CONTRIBUTING, issue/PR templates
- Setup Files & Infrastructure - .gitignore, CI/CD, protected branches
- Maintainer Expectations - Define roles, SLAs, communication
- Security & Vulnerability Reporting - SECURITY.md, vulnerability process
- Funding & Sustainability - GitHub Sponsors (optional but recommended)
Get Started
When a user asks about open sourcing their project, begin by asking:
- "What does your project do?" - Understand scope
- "Who's the audience?" - Know your users
- "Is your git history clean?" - Check for secrets first
Then guide them through the phases using the full AGENTS.md workflow.
Key Resources
- AGENTS.md - Complete 8-phase workflow
- references/file-checklist.md - What files and why
- references/license-selection.md - How to choose
- references/security-practices.md - Clean git history
- references/governance.md - Make decisions sustainably
- references/maintainer-expectations.md - Healthy projects
- references/sponsors-setup.md - Enable funding
- references/template-examples.md - Copy-paste templates
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 annexesCe 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.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/open-source-best-practices-mm8o51ij/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/open-source-best-practices-mm8o51ij' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/open-source-best-practices-mm8o51ij/download' --output '.skill-downloads/open-source-best-practices-mm8o51ij/SKILL.md.part' && mv '.skill-downloads/open-source-best-practices-mm8o51ij/SKILL.md.part' '.skill-downloads/open-source-best-practices-mm8o51ij/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.
Outils déclarés par l’auteur (à vérifier dans votre agent) : file_reader, file_writer, github_api, license_selector, documentation_validator, git_history_analyzer
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/open-source-best-practices-mm8o51ij/SKILL.md' && test -s '.skill-downloads/open-source-best-practices-mm8o51ij/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/open-source-best-practices' && cp -R '.skill-downloads/open-source-best-practices-mm8o51ij' '.claude/skills/open-source-best-practices'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’OpenSkillsopenskills install './.skill-downloads/open-source-best-practices-mm8o51ij'openskills read 'open-source-best-practices-mm8o51ij'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 syncMode 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/open-source-best-practices-mm8o51ij/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.
Bonnes pratiques React Hook Form
Developpement
Maîtrisez React Hook Form : évitez les anti-patterns, gérez les abonnements, et traitez correctement reset, dirty state et entrées contrôlées.
Migration Emotion vers Mantine
Developpement
Migrer les styled-components Emotion vers des composants Mantine avec style props et modules CSS. Pour convertir .styled.tsx ou supprimer les imports @emotion.
Détecteur de dérive de périmètre
Developpement
Analyse les diffs git par rapport à une intention pour détecter la dérive de périmètre, fichiers non liés et PR trop larges, puis suggère de garder, diviser ou justifier.