Repository navigation
docs: 完善维护边界、Issue 规范与安全协作指南 - #2
Merged
Merged
Conversation
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>
7 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
摘要
为个人业余维护的 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 许可及商业使用权限保持不变,不新增软件使用限制或绝对免责主张。
验证
test为SUCCESS;包括格式、Clippy、Rust 测试、release 构建及协议、统计、导入和导入故障场景测试。检查对应 heade992de7fdb620c09d40b2ebe30ee84e416ecd894。git diff --check、暂存区检查及git diff --check origin/main...HEAD通过;最终文件白名单为上述 8 个文件。marked解析/渲染 5 份 Markdown;73 处本地或本仓库文档链接及锚点有效,包括 README 既有导航;原有 README 标题全部保留。LICENSE与origin/main逐字节一致;无 Rust/GPUI、协议、构建、CI、定价或用户配置改动;按任务要求未在本地进行 Cargo 重编译。git interpret-trailers --parse验证提交仅含一次Co-authored-by: Codex <codex@openai.com>,Author / Committer 保持原 Git 用户。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 已勾选全部验收并标记完成。仓库管理员设置未更改,私密漏洞报告开关仍需维护者手动启用。