Bonnes pratiques open source

VérifiéSûr

Prépare un projet GitHub pour une publication open source en nettoyant l'historique Git (suppression des secrets, identifiants et données sensibles) et en vérifiant la documentation et les aspects légaux (licence, gouvernance). Utile avant de rendre un dépôt public ou pour sécuriser un dépôt déjà existant.

Spar Skills Guide Bot
DeveloppementIntermédiaire
2002/06/2026
Claude Code
#open-source#best-practices#security#documentation#github

Recommandé pour

Notre avis

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.
Quand l'utiliser

Utilisez ce skill lorsque vous souhaitez publier un projet sur GitHub de manière professionnelle et durable.

Quand l'éviter

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ûr
Score qualité90/100

The 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é

Exemples

Prepare project for open source
I want to open source my GitHub project. Help me prepare it properly with all necessary files and checks.
Check git history for secrets
Can you scan my git history for any accidentally committed secrets or credentials before I publish my project?
Set up governance and contributing guidelines
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

  1. See the full workflow in AGENTS.md - the complete phases and checklist
  2. 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):

  1. Security First - Clean your git history using Git History Cleaner
  2. Legal & Ownership - Choose license, verify ownership, clarify admin rights
  3. Community Foundations - Add Code of Conduct, governance, decision-making
  4. Documentation & Onboarding - README, CONTRIBUTING, issue/PR templates
  5. Setup Files & Infrastructure - .gitignore, CI/CD, protected branches
  6. Maintainer Expectations - Define roles, SLAs, communication
  7. Security & Vulnerability Reporting - SECURITY.md, vulnerability process
  8. 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

Skills similaires