i-have-adhd的CONTRIBUTING.md详解:贡献者提交PR的完整规范 📅 发布时间:2026/8/31 20:07:26 👁 浏览次数: i-have-adhd的CONTRIBUTING.md详解贡献者提交PR的完整规范【免费下载链接】i-have-adhdA skill to stop your coding agent from burying the answer. ADHD-friendly output.项目地址: https://gitcode.com/GitHub_Trending/ih/i-have-adhdi-have-adhd是一个让 AI 编码助手停止把答案埋在废话里的技能插件Skill/Plugin装进 Claude Code、Codex、Cursor 等工具后助手会先给可执行的下一步、用数字编号拆任务、不再说Hope this helps!。项目明确欢迎人类和 AI Agent 共同贡献而 CONTRIBUTING.md 就是所有贡献者提交 PR 必须遵守的完整规范。本文带你逐条读懂这份规范帮你第一次提交就能被合入。第一步Clone 仓库并定位贡献文档git clone https://gitcode.com/GitHub_Trending/ih/i-have-adhd按照 AGENTS.md 的建议动手前先读两份文件文件作用CONTRIBUTING.md作者身份、标签、安全、验证等全部 PR 要求.github/pull_request_template.md提交 PR 时要填写的模板提前了解能少返工 这个项目支持 12 个以上平台的插件/扩展入口如 hooks/、extensions/、opencode.json改错位置很容易先看文档再动手。核心规范一作者身份三分类Authorship这是 i-have-adhd 最有特色的规定每个 PR 必须且只能选一类作者身份Human-authored人类创作实质性实现和文字由人完成。自动补全、格式化不算混合Autonomous agent-authoredAI 自主创作Agent 做了大部分实质性决策人只给任务并审查结果Hybrid混合人和一个或多个 Agent 都做出了实质性贡献如果是后两类你必须披露用了哪个 Agent/工具、哪个模型版本、它做了什么、人审查了什么、有哪些已知局限。⚠️ 两条铁律不能把 AI 生成的工作说成人类创作或人工独立验证——如果审查者和产出者是同一个 Agent这不算独立验证提交的人类对完整 diff 负全责提交前逐文件阅读删掉 AI 顺手生成的无关改动核心规范二标签体系LabelsPR 需要从三个维度各选标签规则在 CONTRIBUTING.md 的 Labels 一节维度可选值含义TargetTarget:Integrations改 CLI 平台集成Target:Evals改评估脚本evals/、scripts/run_evals.pyTarget:Rules改技能规则skills/i-have-adhd/SKILL.mdTarget:Docs改文档和翻译AuthorAuthor:Human/Author:Hybrid/Author:AI与作者身份分类一一对应Workflowbug/enhancement/issue/question/duplicate缺陷、新功能、通用跟踪等记住标签不能替代 PR 描述和来源披露issue只在没有更精确的标签时才用。核心规范三范围控制与可审查性每个 PR 只聚焦一件事禁止夹带无关格式化、无关依赖变更、AI 生成的填充内容、大范围重写PR 描述必须讲清 4 点改了什么、为什么改改动前后可观察的行为差异安全性、兼容性、副作用实际执行过的验证命令 大行为变更、新增集成、新增 hook、可能有破坏性的改动——先开 issue 讨论再动手。核心规范四安全与副作用红线因为技能文件会被 AI 助手执行、hook 会跑在用户机器上规范划了明确的禁区详见 CONTRIBUTING.md 的 Safety and side effects❌ 技能指令不能让 Agent 读取/外传凭证、token、环境变量、私有文件❌ 不能改用户的 shell 配置、全局 Git 配置、编辑器设置❌ 不能绕过破坏性/特权操作的确认不能静默装软件或拉取远程代码执行❌ 不能暗示该技能可诊断 ADHD它只是输出风格工具README.md 也强调 No ADHD diagnosis needed✅ 仓库代码默认不得修改仓库外的文件、发数据、提权、留后台进程确需外部写入必须显式 opt-in 文档 可回滚对 hookhooks/always-on.mjs 等还额外要求快、有边界、失败安全、可关闭、无多余网络访问可选功能的失败不能阻塞 Agent 启动。核心规范五兼容性与破坏性变更除非明确接受破坏性变更必须保留现有安装方式见 INSTALL.md、调用名/i-have-adhd、文件位置、opt-in 行为、已支持的 12 个以上平台集成。特别规定skills/i-have-adhd/SKILL.md 是权威版本它一变就要同步 Cursor 镜像官方用两条命令验证该同步有 CI 保障见 .github/workflows/cursor-skill-sync.ymlcp skills/i-have-adhd/SKILL.md .cursor/skills/i-have-adhd/SKILL.md cmp skills/i-have-adhd/SKILL.md .cursor/skills/i-have-adhd/SKILL.md破坏性变更移动技能文件、改 hook 语义、改 manifest/安装命令、下线平台必须先有 issue、迁移路径、更新文档和兼容/弃用计划官方倾向增量式、分阶段改法。核心规范六验证与提交清单改 Python 或评估工具时至少跑这两条并把命令和结果写进 PRpython3 -m unittest discover -s tests -v python3 scripts/run_evals.py validate更多检查命令上下文兼容、插件加载等列在 AGENTS.md 的 Verification 一节。行为类改动还需在相同条件下跑基线/候选成对评估单测要用桩和临时文件不碰网络和付费模型。 没跑的检查就明说没跑绝不编造结果也不要把看了代码当成跑了测试。提交前的就绪清单对照 pull_request_template.md 逐项打勾已选唯一作者身份类别AI 参与如实披露人类贡献者已逐文件审查完整 diff无关生成改动已删除变更聚焦副作用、兼容性、成本、验证均已文档化维护者会直接关闭四类 PR隐瞒来源、引入不安全行为、缺乏验证、未计划的破坏性变更——对照上面六条规范自查你的 PR 就能稳稳通过审查。【免费下载链接】i-have-adhdA skill to stop your coding agent from burying the answer. ADHD-friendly output.项目地址: https://gitcode.com/GitHub_Trending/ih/i-have-adhd创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考