AgentSkillsCN

open-source-best-practices

通过确保所有关键文档与法律基础完备，验证并为GitHub项目做好开源发布的准备。在发布前，使用Git History Cleaner识别并移除机密、凭据与敏感数据。当您希望公开发布项目，或强化现有公共仓库时，可使用此功能。

SKILL.md
--- frontmatter
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