贡献者

工程开发 社区

技能解读

当前原文的自动摘译,尚未人工审校。

步骤 1.3 — 在编码之前编写一段范围合同

范围合同是您在打开编辑器之前写给自己的一个段落:目标:<一句话>。范围:<项目符号列表,3-5 项>。明确超出范围:<项目符号列表 - 具体说明您在诱人时会拒绝添加的内容>。然后,每次进行编辑时,询问:“这在范围内吗?”如果您发现自己“当我在这里时……”,请停下来重新审视合同。范围蔓延是“不合并而关闭”的最大单一来源——有关范围规则部分,请参阅references/phase2_implementation.md。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
工程开发
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@daymade · 未声明许可证
上下文用量评级
中等消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
macOS
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
阶段 0——何时使用该技能

当所有这些都成立时使用此技能:您正在为您不维护的存储库做出贡献(维护者可以关闭您的 PR 而无需解释)。这项工作涉及以下一项或多项:源代码、测试、文档、构建配置。您希望合并 PR,而不仅仅是提交。不要将此用于:您自己的存储库、具有共享上下文的内部团队 PR、维护人员正在等待您的热修复分支,或者琐碎的单行更改(一条注释就足够了)。

02
第一阶段——公关前发现

PR 关闭的最常见原因是贡献者认为可接受的内容与维护者已经写下的内容不匹配。在编写代码之前解决这个问题。

03
步骤 1.1 — 将 CONTRIBUTING.md 视为硬合约

CONTRIBUTING.md 不是风格建议。将每个编号规则视为合并的前提条件。特别注意:人工智能辅助缴款条款。在人工智能公关浪潮之后,许多项目在 2024-2026 年添加了这些内容。典型的措辞:“未经事先讨论的人工智能生成的 PR 可能会被关闭”、“你必须能够解释每一行”、“一个问题,一个 PR”。如果存在此条款,则您需要对项目进行明确披露(请参阅第 4 阶段),并且您必须保持 PR 较小。

04
步骤 1.2 — 根据项目基线对 PR 大小进行健全性检查

“小公关”是相对的。在打开 PR 之前,运行: 这会告诉您项目的实际合并 PR 大小分布。如果你的 PR 比最近最大的合并大 5-10 倍,那就是一个红色信号——在提交之前拆分。请参阅`references/phase1_discovery.md`了解基线标准和分割启发式。

05
步骤 1.3 — 在编码之前编写一段范围合同

范围合同是您在打开编辑器之前写给自己的一个段落:目标:<一句话>。范围:<项目符号列表,3-5 项>。明确超出范围:<项目符号列表 - 具体说明您在诱人时会拒绝添加的内容>。然后,每次进行编辑时,询问:“这在范围内吗?”如果您发现自己“当我在这里时……”,请停下来重新审视合同。范围蔓延是关闭而不合并的最大单一来源——有关范围规则部分,请参阅`references/phase2_implementation.md`。

06
步骤 2.1 — 在获取上游后立即分支出 main

始终从上游 `main` (或项目的默认分支)分支,永远不要从你的分支的 `main` 分支,这可能已经过时了。

07
步骤 2.2 — 制作解决问题的最小差异

抵制范围合同未直接要求的任何变更。特别是:不要“当我在这里”重构周围的代码。不要重新格式化您没有触及的行(您的格式化程序可能与项目的不同,即使两者都说“Prettier”)。为了清楚起见,不要重命名变量,除非重命名可以解决问题。如果后续改进确实有价值,请在合并后提交一个单独的问题或打开一个单独的 PR。

08
步骤 2.3 — 常规提交,每次提交一个逻辑更改

使用常规提交:`<type>(<scope>): <description>`,其中类型为`feat | fix | docs | refactor | test | chore | ci | perf`。每个提交都应该可以单独审查。当评论提示修复时,请在推送之前使用`git commit --fixup=<sha>`并用`git -c sequence.editor=: rebase -i --autosquash origin/main`挤压 - 有关完整的修复工作流程,请参阅`references/phase2_implementation.md`。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。