用途:为 Lightdash 仓库中每一个 Pull Request 的正文提供统一约定,无论通过 gh pr create 还是 gt submit 打开都适用。
主要规则:一,PR 标题、描述和提交信息中不得出现客户或客户名称及其数据示例,即使 Linear 工单或 issue 引用了客户名称,也要脱敏为通用表述,如“a customer”“an org”“example values”。二,每个 PR 都要关闭或关联一个 Linear 工单:需要自动关闭时写 Closes: PROD-XXXX,不应自动关闭时写 Relates: PROD-XXXX;若未提供工单,不得编造也不得静默省略,应向开发者指出并索要工单,只有开发者明确确认没有工单时才可不开工单直接创建 PR。三,若存在 GitHub issue,需引用或关闭它:关闭写 Closes: #XXXXX,否则写 Relates: #XXXXX。四,子工单对应父级的 GitHub issue 只能关联、不能关闭,因为子工单的 PR 不应关闭父级的跟踪 issue。
页脚格式:普通 PR 同时关闭 Linear 工单及其 GitHub issue,例如 Closes: PROD-7478 与 Closes: #22801;子工单关闭 Linear 子工单、关联父级 GitHub issue,例如 Closes: PROD-7478 与 Relates: #22801。
创建前检查清单:确认标题、正文和提交中无客户名称或客户数据;存在 Linear 工单的 Closes 或 Relates 行,或开发者已明确确认无工单;若存在 GitHub issue 则有对应的 Closes 或 Relates 行;子工单对父级 GitHub issue 使用关联而非关闭。限制:资料未提供示例代码之外的更多实现细节、平台支持或收费信息。