关于 opensource-contributions
面向开源项目贡献者的技能,涵盖问题报告、拉取请求、审查和发布流程。它强调遵循项目约定、提供清晰证据并降低维护者处理成本,也为代表他人行动的 AI Agent 提供指引。
主要功能
- 01检查项目贡献约定
- 02准备缺陷与功能请求报告
- 03规划并提交拉取请求
- 04跟进 CI 并回应审查意见
- 05遵循发布流程
- 06披露 AI Agent 参与情况
适用场景
- 01报告可复现的仓库缺陷
- 02为开源项目准备拉取请求
- 03提交前检查贡献内容
- 04指导代表他人贡献的 AI Agent
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ magnus919/ agent-skills --skill opensource-contributions安装后在 Claude Code 中输入/opensource-contributions确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdevals/evals.jsonreferences/agent-checklist.mdci-debugging-loop.mdcontribution-idea-filtering.mdcross-fork-org-restriction.mdcross-fork-pr-workaround.mddefault-posture.mdgh-pr-create-body-pitfall.mdgroktocrawl-gaps-worked-example.mdhermes-agent-contributing-case-study.mdhermes-cashew-contributing-worked-example.mdphase-0-before-you-start.mdphase-0a-maintainer-conventions.mdphase-1-filing-issues.mdphase-2-pull-requests.mdphase-3-after-submitting.mdphase-35-followup.mdphase-4-release-process.mdpitfalls.mdrebase-conflict-resolution.mdrelease-workflow-completion.mdremote-code-exploration.mdsequential-pr-conflict-resolution.mdsleep-cycle-refactor-worked-example.mdtracking-upstream-fix-status.mdscripts/check-pr-template-compliance.py详细介绍
开源贡献
黄金法则
让维护者能够轻松吸收你的贡献。 维护者通常是资源不足的志愿者或小型团队。你消除的每个阻碍——不清晰的复现步骤、缺失的测试、不妥当的提交消息、强制推送的历史记录——都能为他们省下时间,让他们不必花时间弄清你做了什么以及为什么这么做。你的目的应该是帮助他们,而不是增加他们的工作量。
何时使用此技能
- 在公开仓库中提交 Bug 报告或功能请求
- 为任何开源项目准备拉取请求
- 在没有书面贡献指南的项目中工作(默认做法)
- 提交前检查自己的 PR
- 为自己的项目制定开源规范
加载相关阶段的参考文档,了解详细说明。
阶段快速概览
| 阶段 | 涵盖内容 | 参考文档 |
|---|---|---|
| 0a — 维护者规范 | README 规范、LICENSE、CONTRIBUTING.md、问题/PR 模板、提交规范、DCO、发布工作流规范 | references/phase-0a-maintainer-conventions.md |
| 0 — 开始之前 | 阅读 CONTRIBUTING.md、检查现有问题/PR、筛选 Bug 修复候选项、大型变更的讨论礼仪 | references/phase-0-before-you-start.md |
| 1 — 提交问题 | Bug 报告和功能请求模板、Agent 披露、维护者工作流(“先提交问题”)、协调多问题路线图、多 PR 计划执行 | references/phase-1-filing-issues.md |
| 2 — 拉取请求 | 分支规范、范围评估、研究现有实现、跨仓库比较、提交消息、PR 模板、文档审查、CI 设置 | references/phase-2-pull-requests.md |
| 3 — 提交之后 | 监控 CI、回应评审反馈、PR 长期没有进展或被关闭时的处理方式 | references/phase-3-after-submitting.md |
| 3.5 — 范围反馈后的跟进 | 系统性调用点审查、提交全面的问题、维护者指出范围缺口时提交配套 PR | references/phase-35-followup.md |
| 4 — 发布流程 | 版本升级、打标签、GitHub Releases 与标签、发布工作流结构、处理发布失败 | references/phase-4-release-process.md |
默认做法(没有 CONTRIBUTING.md)
如果项目没有贡献指南,请加载 references/default-posture.md,了解提交问题、PR、沟通规范和行为准则方面的稳妥默认做法。
Agent 专用检查清单
如果你是代表他人提交问题或贡献的 AI Agent,请在提交任何内容前加载 references/agent-checklist.md。
注意事项
准备提交问题或 PR,或者遇到问题时,请加载 references/pitfalls.md。内容包括:反引号扩展、标签操作无提示失败、强制推送礼仪、“我就快速修一下”的陷阱、跨 Fork 的 PR 问题、合并后的范围蔓延、已安装代码陷阱、CI 调试等。
Agent 专用规则
代表他人提交问题时,务必披露你是 Agent。 在问题正文末尾添加以下一行:
Filed by {{AGENT_NAME}} (AI agent on behalf of {{HUMAN_NAME}})
这是透明度要求,而不是出于礼貌。维护者有权知道自己在和谁沟通。
快速参考卡
| 步骤 | 操作 | 命令 / 检查 |
|---|---|---|
| 0 | 阅读贡献指南 | cat CONTRIBUTING.md 或 .github/CONTRIBUTING.md |
| 0 | 检查现有议题 | gh issue list --search "topic" --state all |
| 1 | 提交错误报告 / 功能请求 | 如有模板,请使用;错误报告需包含复现步骤 |
| 2 | 先提交议题,再编写代码 | 提交议题,等待维护者反馈,然后创建分支 |
| 3 | 创建分支 | git checkout -b fix/description |
| 4 | 提交更改 | git commit -s -m "fix: description" |
| 5 | 在本地运行测试 | make test 或 npm test 或 pytest |
| 6 | 推送 | git push -u origin HEAD |
| 7 | 发起 PR | 完整填写 PR 模板。对于复杂内容,请使用 --body-file |
| 8 | 监控 CI | gh pr checks --watch |
| 9 | 处理评审意见 | 回复评论,推送修正提交。评审后不要强制推送 |
| 10 | 合并后 | git checkout main && git pull && git tag vX.Y.Z && git push origin main --tags |
| 11 | 创建发行版 | gh release create vX.Y.Z --title "vX.Y.Z — Title" --notes-file /tmp/notes.md |
不要使用此技能的情况
- 你是某个项目的唯一维护者,且没有外部贡献者或公开协作者
- 你只是在自己的代码中进行简单的单行修复
- 贡献属于内部协作(同一组织、同一团队),且已有约定俗成的工作流程
- 你已经熟记项目的贡献指南,且当前只是例行工作
- 议题涉及安全漏洞——请改为遵循项目的安全漏洞披露政策
评论
支持 Markdown