메뉴
GitHub 仓库设计与 README 最佳实践指南，帮助创建专业的开源项目结构
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | github-repo-design |
| description | GitHub 仓库设计与 README 最佳实践指南，帮助创建专业的开源项目结构 |
| triggers | ["github repo","repository design","readme design","仓库设计","项目结构","开源项目","profile readme","github profile","readme badge","readme template"] |
基于 100+ 优秀开源项目研究总结的最佳实践指南
当用户需要以下帮助时使用此 skill：
本 skill 采用分包分级架构，按主题组织为独立模块：
| 模块 | 说明 | 路径 |
|---|---|---|
| 01-structure | 仓库核心文件结构 | modules/01-structure/ |
| 02-readme | README 设计指南 | modules/02-readme/ |
| 03-config | 核心配置文件 | modules/03-config/ |
| 04-templates | Issue/PR 模板 | modules/04-templates/ |
| 05-settings | 仓库设置优化 | modules/05-settings/ |
| 模块 | 说明 | 路径 |
|---|---|---|
| 06-cicd | CI/CD 配置 | modules/06-cicd/ |
| 07-profile | GitHub Profile README | modules/07-profile/ |
| 08-security | 安全最佳实践 | modules/08-security/ |
| 09-monorepo | Monorepo 结构 | modules/09-monorepo/ |
| 10-docs | 文档网站集成 | modules/10-docs/ |
| 模块 | 说明 | 路径 |
|---|---|---|
| 11-versioning | 版本管理策略 | modules/11-versioning/ |
| 12-quality | 代码质量工具 | modules/12-quality/ |
| 13-community | 社区建设 | modules/13-community/ |
| 14-i18n | 国际化支持 | modules/14-i18n/ |
| 15-faq | 常见问题 | modules/15-faq/ |
project-name/
├── .github/
│ ├── ISSUE_TEMPLATE/
│ ├── PULL_REQUEST_TEMPLATE.md
│ ├── CODEOWNERS
│ └── workflows/
├── docs/
├── src/
├── tests/
├── README.md
├── LICENSE
├── CONTRIBUTING.md
├── CHANGELOG.md
└── .gitignore
| 许可证 | 特点 | 适用场景 |
|---|---|---|
| MIT | 宽松，允许商用 | 大多数开源项目 |
| Apache 2.0 | 专利保护 | 企业级项目 |
| GPL-3.0 | 强制开源 | 保持开源的项目 |
请参考 modules/02-readme/ 了解 README 设计
根据项目需求，选择相关模块：
modules/02-readme/
├── README.md # README 设计指南
├── badges.md # 徽章配置
└── tools.md # 工具推荐
每个模块包含：
README.md - 模块主文档Complete document processing toolkit - 5 format skills, 3 workflow guides, and 3 templates for PDF, Word, Excel, PowerPoint, and collaborative review.
Multi-AI coordination toolkit router for provider delegation, orchestration patterns, compatibility wrappers, and unified collaboration workflows.
Product management toolkit router with workflow guidance, Lenny-derived PM skills, and reusable PM templates for discovery, strategy, execution, growth, and team leadership.
Interact with Obsidian vaults via the CLI (v1.12.6+). Search, read, create, manage files, tags, properties, tasks, plugins, and more. Use when the user wants to query or manipulate their Obsidian vault programmatically. Requires Obsidian app running with CLI enabled.
Obsidian-centered knowledge management toolkit - 3 format skills, 4 templates, and adjacent productivity skills for knowledge capture, organization, and visualization.
Compatibility wrapper for the legacy PM analytics workflow covering metrics, financial modeling, dashboards, and platform health.