Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub 开源贡献规范

GitHub 标志

一个帮助开发者更稳妥地参与 GitHub 社区的 Skill。

为什么需要它

开源贡献不只是写代码。在开源项目里,一次 Issue 回复、一次认领、一个 Pull Request,都可能影响维护者的时间安排和项目判断。很多低质量互动并不是出于恶意,是因为没有先看清项目规则、Issue 状态和已有讨论。

这个 Skill 把贡献前的检查、沟通和发布流程整理成可执行的规范:

  • 对维护者:减少重复提问、无效认领和不完整的 PR,降低分诊与沟通负担。
  • 对开发者:帮助你理解项目流程,写出有上下文、有依据的评论,与维护者更顺畅地协作。
  • 对社区:让贡献建立在真实的问题理解和可验证的工作上,而不是靠评论数量或模板化表达。

它会做什么

使用这个 Skill 时,AI 会在外部互动前:

  1. 阅读仓库的贡献指南、行为准则、Issue 模板和相关讨论。
  2. 检查 Issue 是否开放、是否已有负责人或关联 PR,以及项目是否要求先申请分配。
  3. 区分已验证事实、个人推测和还没有完成的工作。
  4. 根据当前 Issue 的具体内容起草自然、简洁的评论,避免可复制到任何仓库的套话。
  5. 在发布任何评论前,把目标链接、完整正文、事实依据和未确认事项交给人类审核,并等待这一次发送的明确确认。
  6. 在实现和提交前检查测试、敏感信息、构建产物和项目要求。

它不会做什么

  • 不批量认领 Issue、批量开 PR 或跨仓库复制评论。
  • 不伪造复现结果、测试结果、个人经历或时间承诺。
  • 不把“写得像真人”当成规避检测的方法,也不帮助隐藏自动化行为。
  • 不在没有明确确认的情况下发布评论、创建 Issue、开 Pull Request 或推送代码。
  • 不替代维护者的分配、审核和合并决定。

安装与使用

这是一个遵循 Agent Skills 目录结构的独立 Skill。将整个仓库目录放入你所使用的 AI 工具支持的 skills 目录,然后在需要参与 GitHub 项目时调用 contribution-skills

使用前请确认工具支持 SKILL.mdagents/openai.yamlreferences/ 目录。不同工具的安装位置和调用方式可能不同,请以对应工具的文档为准。

评论审核示例

AI 准备发布评论时,必须先展示类似下面的信息:

发送位置:<仓库>/<Issue 或 PR 链接>

拟发送内容:
<完整评论正文>

依据:<Issue、代码、测试或维护者回复中的已核实事实>
未确认事项:<尚未复现、尚未测试或仍属于推测的内容>

这条评论尚未发送,等待你确认。

人类明确确认后,才能发布这一次完整正文。如果正文或目标发生变化,需要重新确认。

项目结构

contribution-skills/
├── SKILL.md
├── agents/openai.yaml
├── references/issue-comment-humanizer.md
└── assets/cover.jpg

许可证

本项目采用 MIT 许可证,详见 LICENSE。其中 Issue 评论表达部分参考了公开的 humanizer 写作规范,并针对 GitHub 协作场景重新整理,来源信息见 NOTICE.md。该项目与 GitHub 官方没有隶属关系。

欢迎通过 Issue 提出具体的改进建议。提交修改前,请先阅读 CONTRIBUTING.md

About

规范 GitHub 社区贡献流程,帮助开发者与维护者更高效地沟通

Topics

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors