Files

2.9 KiB

参与维护

本仓库维护 SB-Workflow 技能及其使用文档。提出修改前,请先说明触发场景、目标行为和验收方式;涉及授权边界或阶段语义的调整,应明确说明行为影响。

报告问题

在 Issues 中提供:

  • 使用的 Codex 环境,以及显式调用还是自动匹配。
  • 触发问题的提示词、当时的工作阶段和相关任务状态。
  • 预期行为、实际行为,以及可复现的最小示例。
  • 已完成的检查和脱敏后的必要证据。

提交建议时说明希望解决的问题、使用场景和验收条件。分享示例前移除账号凭据、私有项目内容和无关的个人信息。

修改位置

路径 维护约定
sb-workflow/ 技能维护源目录;先在这里修改
.agents/skills/sb-workflow/ 本仓库安装副本;技能变更时同步,包含新增、修改和删除的文件
upstream/fd-engineering/ 原始参考快照;保持文件内容原样
.tasks/sb-workflow.md 项目的适配、验证与维护记录;保留历史证据
根目录文档 安装、用法、协作约定和变更说明

技能引用应使用包内相对路径,不写入开发机绝对路径。修改文件时使用 UTF-8,遵循 .editorconfig;上游快照不参与格式整理。

提交前检查

在仓库根目录运行:

git diff --check
git diff --exit-code -- upstream/fd-engineering

第一条检查差异中的空白错误,第二条核对原始快照没有本地改动。这些检查不能替代内容核对。

按修改范围完成以下验证,并在 Pull Request 中说明实际执行的项目:

  1. 新增或修改的 Markdown 本地链接指向存在的文件,代码块和表格可正常呈现。
  2. sb-workflow/ 与 .agents/skills/sb-workflow/ 的相对文件列表和 SHA-256 一致。
  3. 技能仍包含 SKILL.md、agents/openai.yaml 及 11 份参考文档;变更结构时更新相关引用和说明。
  4. 修改调用方式、阶段或授权规则时,逐项检查八阶段及相关边界场景。
  5. 修改技能发现相关内容时,在实际 Codex 环境检查;仅完成静态检查时明确标注。

仓库当前以指令文档为主,没有构建步骤或自动化测试套件。文档修改无需安装运行时依赖;不要将静态检查写成真实模型运行成功。

提交与评审

  • 每次提交围绕一个明确目标,说明行为或文档发生了什么变化。
  • 用户可见的变更同步补充 CHANGELOG.md;影响安装或用法时同步更新 README.md。
  • Pull Request 说明问题、最终修改、实际验证,以及仍未验证的部分。
  • 不提交令牌、密码、私钥或本地认证文件。Git 认证配置属于仓库元数据或本机凭据存储。

来源与当前许可状态见 NOTICE.md。