diff --git a/.github/DISCUSSION_TEMPLATE/使用问答.yml b/.github/DISCUSSION_TEMPLATE/使用问答.yml new file mode 100644 index 000000000..2a3421739 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/使用问答.yml @@ -0,0 +1,33 @@ +body: + - type: markdown + attributes: + value: | + 欢迎提问。提交前可以搜索已有讨论,并查看[部署文档](https://github.com/zyycn/codex-proxy-rs/blob/main/deploy/README.md)。 + 明确的程序故障请使用 [Issue 模板](https://github.com/zyycn/codex-proxy-rs/issues/new/choose);不确定是不是 Bug,也可以先在这里交流。 + 请移除密钥、令牌、Cookie、代理认证和私人内容,不要上传完整配置或请求转储。解决后请标记帮助到你的答案。 + + - type: textarea + id: question + attributes: + label: 想解决什么问题 + description: 说明希望完成的任务、当前遇到的困难,标题尽量具体。 + validations: + required: true + + - type: input + id: version + attributes: + label: 版本与部署方式 + description: 涉及具体实例时,填写完整版本号或提交号,以及 Docker、二进制或源码部署方式。 + + - type: textarea + id: attempts + attributes: + label: 已尝试的方法与结果 + description: 可以附看过的文档、相关讨论、脱敏错误片段或截图;未尝试可留空。 + + - type: textarea + id: environment + attributes: + label: 相关环境与补充信息 + description: 按问题需要补充操作系统、客户端、反向代理或中转链路,无需提供无关信息。 diff --git a/.github/DISCUSSION_TEMPLATE/实验反馈.yml b/.github/DISCUSSION_TEMPLATE/实验反馈.yml new file mode 100644 index 000000000..75758a502 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/实验反馈.yml @@ -0,0 +1,44 @@ +body: + - type: markdown + attributes: + value: | + 欢迎分享实验版本的使用体验,包括有效、无明显变化或遇到限制的情况。 + 请先查看对应[预发行页面](https://github.com/zyycn/codex-proxy-rs/releases)的部署与数据隔离说明,并搜索已有反馈。 + 明确的程序缺陷请使用 [Issue 模板](https://github.com/zyycn/codex-proxy-rs/issues/new/choose),在两处互相附链接即可,无需重复粘贴。 + 请移除密钥、令牌、Cookie、代理认证和私人内容,不要上传完整配置或请求转储。 + + - type: input + id: version + attributes: + label: 实验版本或提交号 + description: 填写实际运行的完整版本号或提交号,不要只写 exp 或 latest。 + validations: + required: true + + - type: textarea + id: scenario + attributes: + label: 使用场景与环境 + description: 说明启用的实验功能、部署方式、客户端及与结果相关的条件,不需要提供账号身份信息。 + validations: + required: true + + - type: textarea + id: observation + attributes: + label: 观察到的效果或限制 + description: 描述实际现象、出现频率和观察时长;请区分观察结果与原因推测。 + validations: + required: true + + - type: textarea + id: comparison + attributes: + label: 对照与复现信息 + description: 如已对比启用前后或不同配置,请说明条件和结果;没有对照也可以反馈,无需额外测试。 + + - type: textarea + id: references + attributes: + label: 相关链接与补充材料 + description: 可附已有 Issue、讨论、脱敏日志片段或截图。 diff --git a/.github/DISCUSSION_TEMPLATE/想法讨论.yml b/.github/DISCUSSION_TEMPLATE/想法讨论.yml new file mode 100644 index 000000000..a10947bdf --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/想法讨论.yml @@ -0,0 +1,29 @@ +body: + - type: markdown + attributes: + value: | + 这里适合交流尚在探索的想法、方案取舍和使用场景,不要求先给出完整实现。 + 已有明确场景与预期行为时,可以直接提交[功能建议 Issue](https://github.com/zyycn/codex-proxy-rs/issues/new?template=feature-request.yml),无需先开讨论。 + 请先搜索相关讨论,每个主题围绕一个问题展开。 + + - type: textarea + id: use-case + attributes: + label: 使用场景与当前不便 + description: 希望完成什么任务,目前的做法有什么不足? + validations: + required: true + + - type: textarea + id: idea + attributes: + label: 想法与希望讨论的方向 + description: 可以说明期望体验、考虑过的替代方法,以及还不确定的地方。 + validations: + required: true + + - type: textarea + id: references + attributes: + label: 参考资料 + description: 可附相关 Issue、讨论或其他项目的具体行为;示例和截图请先脱敏。 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..cef824aac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: 使用问答 + url: https://github.com/zyycn/codex-proxy-rs/discussions/categories/使用问答 + about: 安装部署、配置和日常使用求助;明确的 Bug 请选择上方问题反馈模板。 + - name: 想法与方案讨论 + url: https://github.com/zyycn/codex-proxy-rs/discussions/categories/想法讨论 + about: 探索尚未明确的需求与方案;具体功能需求也可以直接提交功能建议。 + - name: 实验版体验反馈 + url: https://github.com/zyycn/codex-proxy-rs/discussions/categories/实验反馈 + about: 分享实验版本的使用效果、适用场景和限制。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 317cdd855..8e3f77720 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,16 @@ 本文定义协作流程与审查标准;模块职责以 [系统架构](docs/architecture.md) 为准,视觉规则以 [管理端主题](docs/theme.md) 为准。没有明确约定时遵循相邻实现;具体页面的布局决定不自动成为全项目限制。 -## 提交 Issue +## 交流与反馈 + +[讨论区](https://github.com/zyycn/codex-proxy-rs/discussions) 用于使用问答、想法讨论、实验反馈和经验分享。 +提问时按需补充版本、部署方式、已尝试的方法及脱敏信息;问题解决后,请在「使用问答」中标记有帮助的答案。 + +明确的 Bug、具体功能需求或协作规则建议使用 Issue,无需先开讨论。 +讨论形成可执行事项后,可以新建 Issue 并互相附链接;已有 Issue 的后续信息继续补充在原帖,避免重复记录。 +围绕问题友善交流,欢迎不同使用场景和方案观点。 + +### 提交 Issue 按场景选择 [接口问题反馈](.github/ISSUE_TEMPLATE/api-bug-report.yml)、[常规问题反馈](.github/ISSUE_TEMPLATE/general-bug-report.yml) 或 [功能建议](.github/ISSUE_TEMPLATE/feature-request.yml) 表单,按对应提示提供信息。故障反馈填写实际运行版本和中转链路;接口问题区分客户端显示与网关实际响应,页面问题附相关截图或录屏。 diff --git a/README.md b/README.md index ddf966dee..26178f98f 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,13 @@ curl http://127.0.0.1:8080/v1/models \ ## 社区 +欢迎到 [Discussions 讨论区](https://github.com/zyycn/codex-proxy-rs/discussions)交流: +[使用问答](https://github.com/zyycn/codex-proxy-rs/discussions/categories/使用问答)、 +[想法讨论](https://github.com/zyycn/codex-proxy-rs/discussions/categories/想法讨论)、 +[实验反馈](https://github.com/zyycn/codex-proxy-rs/discussions/categories/实验反馈)与 +[经验分享](https://github.com/zyycn/codex-proxy-rs/discussions/categories/经验分享)。 +明确的 Bug 或功能需求请使用 [Issue 模板](https://github.com/zyycn/codex-proxy-rs/issues/new/choose),无需先发讨论。 + 感谢 [LINUX DO](https://linux.do) 社区提供开放、友善的技术交流平台。 ## 许可证