Skip to content

docs: 完善维护边界、Issue 规范与安全协作指南 - #2

Merged
gloryhui merged 1 commit into
mainfrom
codex/issue-1-repository-governance
Oct 21, 2026
Merged

gloryhui merged 1 commit into
mainfrom
codex/issue-1-repository-governance

Conversation

@gloryhui

@gloryhui gloryhui commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

摘要

为个人业余维护的 WorkBuddy Proxy 补齐免费维护、反馈处理和社区协作边界,区分 MIT 开源授权与维护承诺,给普通问题和敏感漏洞提供清晰的反馈指引。

Closes #1

变更

仅包含以下 8 个治理文档和 Issue 配置文件:

  • README.md:新增「维护与支持说明」及顶部导航,链接新文档,保留原有功能、安装与安全说明。
  • SUPPORT.md:说明无 SLA 的免费维护、反馈顺序、问题分类、补充/合并/关闭规则和商用自主管理责任。
  • SECURITY.md:说明重点安全范围、最新正式版与明确维护分支的补丁原则,以及私密报告入口不可用时的处理方式;不固定版本号或虚构渠道。
  • CONTRIBUTING.md:说明最小复现、脱敏、聚焦 PR 和按范围验证,引用既有 AGENTS.md。
  • CODE_OF_CONDUCT.md:采用简洁的自定义社区规则,维护者同样受约束,保护正常负面评价和有证据的 Bug 反馈。
  • .github/ISSUE_TEMPLATE/bug_report.yml:8 个输入字段(6 必填),涵盖版本、系统/架构、相关上游信息、复现、预期/实际结果、可选证据及影响范围。
  • .github/ISSUE_TEMPLATE/feature_request.yml:场景、痛点、期望效果和替代方案,明确提交不代表实现承诺。
  • .github/ISSUE_TEMPLATE/config.yml:引导查阅文档、搜索 Issue 和安全报告指南,保留空白 Issue 供普通使用问题提交,不依赖 Discussions。

所有入口强调禁止上传凭据、真实对话、隐私、完整配置及私密数据库;复现不要求公网服务、商业账号或真实密钥。MIT 许可及商业使用权限保持不变,不新增软件使用限制或绝对免责主张。

验证

  • 合并后实查 GitHub 正式新建 Issue 页面:Bug、Feature、Blank issue 均能正常打开;Bug 的 8 个输入字段(6 必填)、Feature 的 4 个输入字段,以及脱敏、私密报告和维护边界提示正确渲染;GitHub 自动识别贡献、安全、行为与支持文档。未创建测试 Issue。
  • 2026-10-22 复核:Issue docs: 完善开源维护边界、Issue 规范、安全报告与社区行为准则 #1 的 7 项验收逐项通过,未发现需修复的文档或模板缺漏,无未处理评审线程。重新执行 Markdown、3 份 YAML、字段结构、73 处链接/锚点、8 文件范围与 LICENSE 一致性验证,全部通过。
  • PR Core checks #101 已成功完成,唯一 PR 检查 test 为 SUCCESS;包括格式、Clippy、Rust 测试、release 构建及协议、统计、导入和导入故障场景测试。检查对应 head e992de7fdb620c09d40b2ebe30ee84e416ecd894。
  • git diff --check、暂存区检查及 git diff --check origin/main...HEAD 通过;最终文件白名单为上述 8 个文件。
  • 使用现有 Node marked 解析/渲染 5 份 Markdown;73 处本地或本仓库文档链接及锚点有效,包括 README 既有导航;原有 README 标题全部保留。
  • 使用 Ruby Psych 安全解析 3 份 YAML,递归检查无重复键;两份表单的顶层字段、输入类型、唯一 ID/标签、字符串属性和布尔必填规则均通过结构检查;配置保留普通 Issue 入口。
  • 对照 GitHub Issue Form 语法和表单字段规范核对所用结构。表单及配置须进入默认分支后才在正式新建 Issue 入口生效,本次未提交测试 Issue。
  • LICENSE 与 origin/main 逐字节一致;无 Rust/GPUI、协议、构建、CI、定价或用户配置改动;按任务要求未在本地进行 Cargo 重编译。
  • 使用 git interpret-trailers --parse 验证提交仅含一次 Co-authored-by: Codex <codex@openai.com>,Author / Committer 保持原 Git 用户。
  • 验证采用现有运行时与内存解析,本轮未创建构建缓存或临时文件:清理/释放 0 B,保留本轮临时产物 0 B;既有临时目录因归属不明而保留。检查时系统盘剩余约 55.65 GiB。原有未跟踪 output/ 未改动或纳入提交。

需人工操作

  • 已只读查询 GET /repos/gloryhui/workbuddy-proxy/private-vulnerability-reporting,结果为 {"enabled":false}。请维护者在仓库 Settings → Security 中启用 Private vulnerability reporting(具体分组以 GitHub 界面为准),再确认 Security → Advisories → Report a vulnerability 私密入口可见。Markdown 和本 PR 不会自动开启该设置;未启用前按 SECURITY.md 暂缓接收敏感详情。

结论

Issue #1 要求的治理文档与模板已完成并通过本地文档、链接、YAML 和字段结构验证。本 PR 使用独立分支交付,CI 与 7 项验收复核均通过,已按用户明确授权合并到 main(e96f5a8)。Issue #1 已勾选全部验收并标记完成。仓库管理员设置未更改,私密漏洞报告开关仍需维护者手动启用。

Add support, security, contribution and conduct guidance with focused issue forms.
Preserve MIT licensing, existing feature documentation and ordinary issue access.

Co-authored-by: Codex <codex@openai.com>
@gloryhui
gloryhui merged commit e96f5a8 into main Oct 21, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: 完善开源维护边界、Issue 规范、安全报告与社区行为准则

1 participant