用途
GitHub Repo Curator 用于把分散的 GitHub 仓库整理成专业作品集,并提升仓库的可维护性。它围绕个人资料展示、仓库组织、文档规范、清理流程和 Git 规范提供模板与操作指引。
主要能力
个人资料优化
- 提供个人资料 README 模板,用于创建
[username]/[username]/README.md作为个人主页落地页,包含定位语、当前项目、正在学习、职业方向、联系方式、技术栈、徽章以及可选的 GitHub 统计与活动图。 - 建议固定(Pin)6 个仓库,分别覆盖:最佳技术作品、与目标岗位最相关、活跃/维护中的项目、展示不同技能、个人/热情项目、协作项目。
仓库组织
- 命名约定:推荐
[type]-[name]或[name]-[technology]模式,例如portfolio-website、cli-tool-name、react-component-library、python-data-pipeline、api-gateway-service;避免test123、my-project、untitled、asdfgh。 - 可见性策略:公开用于作品集、开源、学习;私有用于客户工作、未完成项目、实验;归档用于已完成/放弃但有保留价值的内容;删除用于真正过时、尴尬或冗余的内容。
- 仓库审计清单:对每个仓库决定保留公开、保留私有、归档或删除。
README 框架
- 最小 README:项目名称、简要描述、安装、用法、许可证。
- 标准 README:徽章(构建状态、许可证、版本)、一段式描述、功能列表、快速开始(前置条件、安装、用法)、文档链接、贡献链接、许可证、致谢。
- 全面 README:参见
references/readme-template.md。
文档标准
- 文件结构示例:
README.md、CONTRIBUTING.md、LICENSE、CHANGELOG.md、CODE_OF_CONDUCT.md、docs/(getting-started、api-reference、examples、troubleshooting)、.github/(ISSUE_TEMPLATE、PULL_REQUEST_TEMPLATE、workflows)、src/。 - 提供 CONTRIBUTING.md 模板:报告缺陷、建议功能、提交拉取请求、开发环境设置、代码风格、测试。
- 提供 CHANGELOG.md 模板:基于 Keep a Changelog 与语义化版本,包含 Unreleased、Added、Changed、Fixed 等段落。
徽章
- 构建与状态、包信息、许可证与社交、技术类徽章示例。
- 自定义徽章可使用 shields.io。
仓库清理工作流
- 阶段 1 审计:列出所有仓库、按用途/状态分类、识别缺口、标记待处理动作。
- 阶段 2 清理:删除真正过时的仓库、归档已完成/放弃的、将不适合展示的设为私有、更新可见性设置。
- 阶段 3 打磨:添加/更新 README、添加许可证、更新描述与主题、添加相关徽章、必要时清理提交历史。
- 阶段 4 展示:固定最佳仓库、创建/更新个人资料 README、用主题/标签组织、交叉链接相关项目。
Topics/标签策略
- 可用于:主要语言(
python、typescript、rust)、框架(react、nextjs、fastapi)、领域(machine-learning、web-dev、cli)、类型(library、tool、template、tutorial)、状态(active、archived、experimental)。 - 示例主题集:
typescript react nextjs portfolio web-development。
Git 规范
- 提交信息格式:
type(scope): subject,可选 body 与 footer;类型包括feat、fix、docs、style、refactor、test、chore。 - 分支策略:
main(生产就绪)、develop(集成分支)、feature/*、bugfix/*、release/*、hotfix/*。 .gitignore要点:依赖(node_modules/、venv/、.env)、构建(dist/、build/、*.pyc)、IDE(.vscode/、.idea/、*.swp)、操作系统(.DS_Store、Thumbs.db)、密钥(*.pem、*.key、.env.local)。
使用方式
该技能以模板和操作指引形式提供,可直接参考其中的 README、CONTRIBUTING、CHANGELOG 模板与清理工作流来整理仓库。参考资料包括 references/readme-template.md(完整 README 模板)、references/license-guide.md(选择许可证)、references/github-actions.md(CI/CD 工作流)。
适用场景
- 将零散仓库整理为求职或展示用的作品集。
- 统一多个仓库的 README 与文档规范。
- 对已有仓库进行审计、清理、归档或删除决策。
- 建立提交信息与分支命名规范。
限制
资料未提供该技能的安装命令、运行环境、收费方式、平台支持范围或效果保证,这些信息暂未提供。