⚡

GitHub仓库管理专家 github-repo-curator

这是一个用于整理和优化GitHub仓库的技能，帮助用户提升项目展示、可维护性和个人资料专业性。通过使用README模板、文档标准、仓库组织模式和清理工作流，实现代码库高效管理和开源项目优化。关键词：GitHub管理、代码库优化、README模板、仓库组织、技能展示、SEO友好、开源项目维护、DevOps工具。

DevOps 0 次安装 0 次浏览 更新于 3/7/2026

name: github-repo-curator description: 整理GitHub仓库以实现专业展示和可维护性。README模板、文档标准、仓库组织模式和资料优化。触发于GitHub清理、仓库整理、README编写或开源展示请求。 license: MIT

GitHub 仓库整理师

将零散的仓库转变为专业的作品集。

资料优化

个人资料 README

为个人资料页面创建 [用户名]/[用户名]/README.md：

# 你好，我是 [名字] 👋

[一句话定位陈述]

## 🔭 当前正在从事
- [项目1] - [简短描述]
- [项目2] - [简短描述]

## 🌱 当前正在学习
- [技术/技能]

## 💼 专业焦点
[2-3句关于你的工作和兴趣]

## 📫 如何联系我
- [电子邮件/LinkedIn/网站]

## 🛠️ 技术栈
![Python](https://img.shields.io/badge/-Python-3776AB?style=flat&logo=python&logoColor=white)
![TypeScript](https://img.shields.io/badge/-TypeScript-3178C6?style=flat&logo=typescript&logoColor=white)
[添加相关徽章]

---
[可选：GitHub统计数据、活动图等]

固定仓库

固定6个展示性仓库：

  1. 最佳技术作品（最令人印象深刻的）
  2. 与目标职位最相关
  3. 活跃/维护中的项目
  4. 展示不同技能（广度）
  5. 个人/热情项目（个性化）
  6. 合作工作（团队协作）

仓库组织

命名约定

# 模式：[类型]-[名称] 或 [名称]-[技术]

# 好
作品集网站
cli-工具名称
react-组件库
python-数据管道
api-网关服务

# 避免
test123
我的项目
未命名
asdfgh

可见性策略

可见性 用于
公开 作品集、开源、学习
私有 客户工作、未完成项目、实验
归档 已完成/放弃但有参考价值
删除 真正过时、尴尬或冗余

仓库审核清单

对每个仓库，决定：

  • [ ] 保持公开（适合作品集）
  • [ ] 保持私有（有价值但不展示）
  • [ ] 归档（完成但有参考价值）
  • [ ] 删除（无价值）

README 框架

最小 README

# 项目名称

简要描述这个项目做什么。

## 安装

```bash
npm install project-name

使用

import { thing } from 'project-name';
thing.doSomething();

许可证

MIT


### 标准 README

````markdown
# 项目名称

![构建状态](https://img.shields.io/badge/build-passing-brightgreen)
![许可证](https://img.shields.io/badge/license-MIT-blue)
![版本](https://img.shields.io/badge/version-1.0.0-orange)

一段描述项目：它做什么、为谁设计、为什么存在。

## 特性

- ✅ 特性一
- ✅ 特性二
- ✅ 特性三

## 快速开始

### 先决条件

- Node.js >= 18
- npm 或 yarn

### 安装

```bash
git clone https://github.com/user/project
cd project
npm install

使用

npm start

文档

[链接到完整文档或wiki]

贡献

[链接到 CONTRIBUTING.md]

许可证

本项目根据 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_report.md
│   │   └── feature_request.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   └── workflows/      # GitHub Actions
└── src/                # 源代码
```

### CONTRIBUTING.md 模板

```markdown
# 贡献给 [项目名称]

感谢你有兴趣贡献！

## 如何贡献

### 报告错误

1. 检查现有问题
2. 使用错误报告模板
3. 包括复现步骤

### 建议特性

1. 检查现有特性请求
2. 使用特性请求模板
3. 解释用例

### 拉取请求

1. 分叉仓库
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交更改 (`git commit -m '添加惊人特性'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 打开拉取请求

## 开发设置

[本地开发说明]

## 代码风格

[风格指南或链接到linter配置]

## 测试

[如何运行测试]
```

### CHANGELOG.md 模板

```markdown
# 变更日志

此项目的所有重要更改将记录在此文件中。

格式基于 [Keep a Changelog](https://keepachangelog.com/)，
且此项目遵循 [Semantic Versioning](https://semver.org/)。

## [未发布]

### 添加
- 新特性 X

### 更改
- 更新依赖 Y

### 修复
- 特性 Z 中的错误

## [1.0.0] - 2024-01-15

### 添加
- 初始发布
- 特性 A
- 特性 B
```

---

## 徽章

### 构建与状态
```markdown
![构建状态](https://github.com/user/repo/workflows/CI/badge.svg)
![覆盖率](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
```

### 包信息
```markdown
![npm 版本](https://img.shields.io/npm/v/package-name)
![下载量](https://img.shields.io/npm/dm/package-name)
```

### 许可证与社交
```markdown
![许可证](https://img.shields.io/github/license/user/repo)
![星标](https://img.shields.io/github/stars/user/repo)
![分支](https://img.shields.io/github/forks/user/repo)
```

### 技术
```markdown
![用 Python 制作](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)
```

### 徽章生成器
使用 [shields.io](https://shields.io) 生成自定义徽章。

---

## 仓库清理工作流

### 阶段 1：审核

1. 列出所有仓库
2. 按目的/状态分类
3. 识别差距（缺少什么？）
4. 标记行动（保持/归档/删除）

### 阶段 2：清理

1. 删除真正过时的仓库
2. 归档已完成/放弃的
3. 私有化任何不适合作品集的
4. 更新可见性设置

### 阶段 3：打磨

1. 添加/更新 README
2. 添加许可证
3. 更新描述和主题
4. 添加相关徽章
5. 如有需要清理提交历史

### 阶段 4：展示

1. 固定最佳仓库
2. 创建/更新个人资料 README
3. 用主题/标签组织
4. 交叉链接相关项目

---

## 主题/标签策略

### 用于主题：
- 主要语言：`python`, `typescript`, `rust`
- 框架：`react`, `nextjs`, `fastapi`
- 领域：`机器学习`, `web-开发`, `cli`
- 类型：`库`, `工具`, `模板`, `教程`
- 状态：`活跃`, `归档`, `实验性`

### 示例主题集：
```
typescript react nextjs portfolio web-development
```

---

## 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 工作流