name: github-repo-curator description: 组织GitHub仓库以进行专业展示和维护性。README模板、文档标准、仓库组织模式和资料优化。触发于GitHub清理、仓库组织、README编写或开源展示请求。 license: MIT
GitHub仓库管理员
将分散的仓库转换为专业投资组合。
资料优化
个人资料README
创建[用户名]/[用户名]/README.md用于个人资料着陆页：
# 你好，我是[姓名] 👋
[一句话定位声明]
## 🔭 当前工作
- [项目1] - [简要描述]
- [项目2] - [简要描述]
## 🌱 当前学习
- [技术/技能]
## 💼 专业焦点
[2-3句话关于工作和兴趣]
## 📫 联系我
- [邮箱/LinkedIn/网站]
## 🛠️ 技术栈
[添加相关徽章]
---
[可选：GitHub统计、活动图表等]
置顶仓库
置顶6个仓库以展示：
- 最佳技术工作（最令人印象深刻）
- 最相关目标角色
- 活跃/维护项目
- 展示不同技能（范围）
- 个人/热情项目（个性）
- 协作工作（团队合作）
仓库组织
命名约定
# 模式：[类型]-[名称] 或 [名称]-[技术]
# 好
投资组合网站
cli工具名称
react组件库
python数据管道
api网关服务
# 避免
test123
我的项目
未命名
asdfgh
可见性策略
| 可见性 | 用途 |
|---|---|
| 公开 | 投资组合件、开源、学习 |
| 私有 | 客户工作、未完成项目、实验 |
| 归档 | 已完成/废弃但值得保留 |
| 删除 | 真正过时、尴尬或冗余 |
仓库审核清单
对每个仓库，决定：
- [ ] 保持公开（值得投资组合）
- [ ] 保持私有（有价值但不展示）
- [ ] 归档（完成但有参考价值）
- [ ] 删除（无价值）
README框架
最小README
# 项目名称
简要描述此项目的功能。
## 安装
```bash
npm install 项目名称
使用
import { 东西 } from '项目名称';
东西.做某事();
许可证
MIT
### 标准README
````markdown
# 项目名称
一段描述项目的段落：它的功能、面向谁以及为什么存在。
## 功能
- ✅ 功能一
- ✅ 功能二
- ✅ 功能三
## 快速开始
### 先决条件
- Node.js >= 18
- npm 或 yarn
### 安装
```bash
git clone https://github.com/用户/项目
cd 项目
npm install
使用
npm start
文档
[链接到完整文档或wiki]
贡献
许可证
本项目根据MIT许可证许可 - 查看LICENSE文件。
致谢
- [致谢1]
- [致谢2]
### 全面README
参见`references/readme-template.md`
---
## 文档标准
### 文件结构
```
项目/
├── README.md # 项目概述
├── CONTRIBUTING.md # 如何贡献
├── LICENSE # 许可证文件
├── CHANGELOG.md # 版本历史
├── CODE_OF_CONDUCT.md # 社区标准
├── docs/ # 扩展文档
│ ├── 入门指南.md
│ ├── API参考.md
│ ├── 示例.md
│ └── 故障排除.md
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug报告.md
│ │ └── 功能请求.md
│ ├── PULL_REQUEST_TEMPLATE.md
│ └── workflows/ # GitHub Actions
└── src/ # 源代码
```
### CONTRIBUTING.md模板
```markdown
# 贡献于[项目名称]
感谢您有兴趣贡献！
## 如何贡献
### 报告错误
1. 检查现有问题
2. 使用错误报告模板
3. 包括复现步骤
### 建议功能
1. 检查现有功能请求
2. 使用功能请求模板
3. 解释用例
### 拉取请求
1. 分叉仓库
2. 创建功能分支（`git checkout -b feature/神奇功能`）
3. 提交更改（`git commit -m '添加神奇功能'`）
4. 推送分支（`git push origin feature/神奇功能`）
5. 打开拉取请求
## 开发设置
[本地开发说明]
## 代码风格
[风格指南或链接到linter配置]
## 测试
[如何运行测试]
```
### CHANGELOG.md模板
```markdown
# 变更日志
此项目的所有显著变更将记录在此文件中。
格式基于[保持变更日志](https://keepachangelog.com/)，
且本项目遵循[语义版本化](https://semver.org/)。
## [未发布]
### 添加
- 新功能X
### 更改
- 更新依赖Y
### 修复
- 功能Z中的错误
## [1.0.0] - 2024-01-15
### 添加
- 初始发布
- 功能A
- 功能B
```
---
## 徽章
### 构建与状态
```markdown
```
### 包信息
```markdown
```
### 许可证与社交
```markdown
```
### 技术
```markdown
```
### 徽章生成器
使用[shields.io](https://shields.io)自定义徽章。
---
## 仓库清理工作流程
### 阶段1：审核
1. 列出所有仓库
2. 按目的/状态分类
3. 识别缺口（缺少什么？）
4. 标记操作（保持/归档/删除）
### 阶段2：清理
1. 删除真正过时仓库
2. 归档已完成/废弃
3. 私有化任何非投资组合就绪内容
4. 更新可见性设置
### 阶段3：优化
1. 添加/更新READMEs
2. 添加许可证
3. 更新描述和主题
4. 添加相关徽章
5. 如需清理提交历史
### 阶段4：展示
1. 置顶最佳仓库
2. 创建/更新个人资料README
3. 用主题/标签组织
4. 交叉链接相关项目
---
## 主题/标签策略
### 使用主题为：
- 主要语言：`python`、`typescript`、`rust`
- 框架：`react`、`nextjs`、`fastapi`
- 领域：`机器学习`、`web开发`、`cli`
- 类型：`库`、`工具`、`模板`、`教程`
- 状态：`活跃`、`归档`、`实验性`
### 示例主题集：
```
typescript react nextjs 投资组合 web开发
```
---
## Git卫生
### 提交消息
```
类型(范围): 主题
正文（可选）
脚注（可选）
```
类型：`feat`、`fix`、`docs`、`style`、`refactor`、`test`、`chore`
### 分支策略
```
main # 生产就绪
develop # 集成分支
feature/* # 新功能
bugfix/* # 错误修复
release/* # 发布准备
hotfix/* # 生产修复
```
### .gitignore基本内容
```gitignore
# 依赖
node_modules/
venv/
.env
# 构建
dist/
build/
*.pyc
# IDE
.vscode/
.idea/
*.swp
# OS
.DS_Store
Thumbs.db
# 秘密
*.pem
*.key
.env.local
```
---
## 参考资料
- `references/readme-template.md` - 完整README模板
- `references/license-guide.md` - 选择许可证
- `references/github-actions.md` - CI/CD工作流程