Browse Source

chore: add GitHub issue/PR templates and discussions link

lingfengQAQ 2 weeks ago
parent
commit
3d055bc8ea

+ 111 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,111 @@
+name: Bug 反馈
+description: 反馈命令、Agent、数据链或 Dashboard 中可复现的问题。
+title: "【Bug】"
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        感谢帮助改进 Webnovel Writer。请尽量提供可复现信息;如果涉及小说正文、API Key 或个人数据,请先脱敏。
+  - type: textarea
+    id: summary
+    attributes:
+      label: 问题概述
+      description: 简短说明发生了什么。
+      placeholder: "例如:执行 /webnovel-write 12 后 review-pipeline 通过,但没有生成 CHAPTER_COMMIT。"
+    validations:
+      required: true
+  - type: dropdown
+    id: area
+    attributes:
+      label: 影响范围
+      description: 请选择问题涉及的模块。
+      multiple: true
+      options:
+        - Claude Code Skill 命令
+        - Python CLI
+        - Story System / CHAPTER_COMMIT
+        - RAG / reference search
+        - Dashboard
+        - Agent 提示词 / 工作流
+        - 模板 / 题材画像
+        - 文档
+        - 其他
+    validations:
+      required: true
+  - type: input
+    id: command
+    attributes:
+      label: 触发命令或入口
+      description: 是哪个命令触发了问题?
+      placeholder: "/webnovel-write 12 或 python -X utf8 ... webnovel.py preflight"
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: 复现步骤
+      description: 请写出最小、稳定的复现步骤。
+      placeholder: |
+        1. 使用 ... 安装插件
+        2. 在 ... 项目中执行 ...
+        3. 看到 ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: 预期行为
+      description: 正常情况下应该发生什么?
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: 实际行为
+      description: 实际发生了什么?如有报错或日志,请贴出关键片段。
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: 运行环境
+      description: 请补充版本和平台信息。
+      value: |
+        - 操作系统:
+        - Python 版本:
+        - Claude Code 版本:
+        - 插件版本:
+        - 安装范围:user / project
+    validations:
+      required: true
+  - type: input
+    id: model
+    attributes:
+      label: 使用模型
+      description: 请填写触发问题时使用的模型名称;不确定时请写“未知”。
+      placeholder: "例如:deepseek-v4-pro / gpt-5.5 / claude-opus-4-8 / claude-sonnet-4-6 / gemini-3.1-pro-preview / gemini-3.5-flash"
+    validations:
+      required: true
+  - type: textarea
+    id: diagnostics
+    attributes:
+      label: 诊断信息
+      description: 请贴出相关 preflight/status 输出。请先脱敏 API Key、私密正文和个人信息。
+      placeholder: |
+        python -X utf8 "<CLAUDE_PLUGIN_ROOT>/scripts/webnovel.py" --project-root "<PROJECT_ROOT>" preflight --format json
+  - type: textarea
+    id: files
+    attributes:
+      label: 相关文件或状态
+      description: 请列出相关文件、commit artifact、截图或 Dashboard 页面。除非必要,不要粘贴私密章节全文。
+      placeholder: ".story-system/commits/chapter_012.commit.json, .webnovel/state.json, Dashboard > System"
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: 提交前检查
+      options:
+        - label: 我已经搜索过现有 Issue,确认不是重复反馈。
+          required: true
+        - label: 我已经移除或脱敏 API Key、私密小说内容和个人信息。
+          required: true
+        - label: 我提供了足够用于复现或诊断的信息。
+          required: true

+ 11 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 提问与交流
+    url: https://github.com/lingfengQAQ/webnovel-writer/discussions
+    about: 使用问题、创作思路或想法交流请到 Discussions,通常不必开 Issue。
+  - name: 文档中心
+    url: https://github.com/lingfengQAQ/webnovel-writer/tree/master/docs
+    about: 提 Issue 前建议先查看文档,确认是否已有说明。
+  - name: 命令详解
+    url: https://github.com/lingfengQAQ/webnovel-writer/blob/master/docs/guides/commands.md
+    about: 查看 Skill 命令、CLI 入口和常见工作流。

+ 62 - 0
.github/ISSUE_TEMPLATE/docs_template_request.yml

@@ -0,0 +1,62 @@
+name: 文档或模板建议
+description: 建议改进文档、题材模板、参考资料、示例或新手引导。
+title: "【Docs/Templates】"
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        好的文档或模板建议,最好先指出现在哪里不清楚、缺失或过时,再说明你希望补成什么样。如需举例,请只贴脱敏后的短片段。
+  - type: textarea
+    id: target
+    attributes:
+      label: 需要改什么?
+      description: 哪个文档、模板、题材画像、参考文件或新手步骤需要调整?
+      placeholder: "例如:docs/guides/genres.md 需要补充玄幻 + 规则怪谈复合题材的使用说明。"
+    validations:
+      required: true
+  - type: textarea
+    id: gap
+    attributes:
+      label: 当前问题
+      description: 现在有哪些内容令人困惑、缺失、过时或不好用?
+    validations:
+      required: true
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: 建议改法
+      description: 请描述你希望增加的说明、示例、模板字段或参考规则。
+    validations:
+      required: true
+  - type: dropdown
+    id: audience
+    attributes:
+      label: 主要受众
+      description: 谁最需要这个改进?
+      options:
+        - 新用户
+        - 插件维护者
+        - 题材 / 模板贡献者
+        - Dashboard 用户
+        - 高级 CLI 用户
+        - 其他
+    validations:
+      required: true
+  - type: input
+    id: model
+    attributes:
+      label: 使用模型
+      description: 如果这个建议和模型输出、提示词或 Agent 行为有关,请填写模型名称;不相关时请填“不适用”。
+      placeholder: "例如:deepseek-v4-pro / gpt-5.5 / claude-opus-4-8 / claude-sonnet-4-6 / gemini-3.1-pro-preview / gemini-3.5-flash / 不适用"
+    validations:
+      required: true
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: 提交前检查
+      options:
+        - label: 我已经检查过现有文档和模板。
+          required: true
+        - label: 我没有包含私密小说内容;如必须举例,也只提供了短片段并已脱敏。
+          required: true

+ 82 - 0
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,82 @@
+name: 功能建议
+description: 建议新的能力、工作流优化、模板或集成。
+title: "【Feature】"
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        好的功能建议应该先说明写作工作流中的问题,再说明你希望系统如何解决。
+  - type: textarea
+    id: problem
+    attributes:
+      label: 要解决的问题
+      description: 你遇到的是写作、规划、审查、记忆、RAG 还是 Dashboard 方面的问题?
+      placeholder: "例如:多卷连载时,进入下一卷规划前很难判断哪些未回收伏笔应该优先处理。"
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: 期望方案
+      description: 你希望 Webnovel Writer 做什么?
+    validations:
+      required: true
+  - type: dropdown
+    id: area
+    attributes:
+      label: 目标模块
+      description: 请选择这个建议主要影响的模块。
+      multiple: true
+      options:
+        - 初始化流程
+        - 规划流程
+        - 写章流程
+        - 审查流程
+        - 查询 / 记忆
+        - Story System / 数据链
+        - RAG / reference search
+        - Dashboard
+        - 题材模板
+        - 文档
+        - 其他
+    validations:
+      required: true
+  - type: input
+    id: model
+    attributes:
+      label: 使用模型
+      description: 如果这个建议和模型表现有关,请填写模型名称;不相关时请填“不适用”。
+      placeholder: "例如:deepseek-v4-pro / gpt-5.5 / claude-opus-4-8 / claude-sonnet-4-6 / gemini-3.1-pro-preview / gemini-3.5-flash / 不适用"
+    validations:
+      required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: 示例工作流
+      description: 请描述用户会如何使用这个功能。
+      placeholder: |
+        1. 用户执行 ...
+        2. 系统展示 ...
+        3. 用户确认 ...
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: 备选方案
+      description: 你考虑过哪些替代方案、手动 workaround 或更小的实现方式?
+  - type: textarea
+    id: impact
+    attributes:
+      label: 影响和风险
+      description: 请说明兼容性、数据迁移、隐私、提示词行为或维护成本方面的影响。
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: 提交前检查
+      options:
+        - label: 我已经搜索过现有 Issue,确认不是重复建议。
+          required: true
+        - label: 我描述的是用户工作流或写作问题,而不只是实现细节。
+          required: true
+        - label: 我考虑过这个改动更适合放在文档、模板、提示词、脚本还是 Dashboard 中。
+          required: true

+ 61 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,61 @@
+## 变更摘要
+
+<!-- 简短说明改了什么,以及为什么改。 -->
+
+## 关联 Issue
+
+<!-- 如有关联 Issue,请写在这里。示例:Closes #123 -->
+
+## 变更类型
+
+- [ ] Bug 修复
+- [ ] 新功能
+- [ ] 文档
+- [ ] 模板 / 题材画像
+- [ ] Dashboard
+- [ ] 重构
+- [ ] 测试
+- [ ] 发版 / 打包
+
+## 影响范围
+
+- [ ] `/webnovel-init`
+- [ ] `/webnovel-plan`
+- [ ] `/webnovel-write`
+- [ ] `/webnovel-review`
+- [ ] `/webnovel-query` 或 memory
+- [ ] Story System / CHAPTER_COMMIT
+- [ ] RAG / reference search
+- [ ] Dashboard
+- [ ] 文档 / 模板 / references
+- [ ] Marketplace / 插件发版
+
+## 验证方式
+
+<!-- 请列出你实际运行过的命令。没有测试时,请说明原因。 -->
+
+- [ ] `python -m pytest`
+- [ ] 已对受影响命令或工作流做 smoke test
+- [ ] 数据链有变化时,已在示例项目上运行 `preflight`
+- [ ] UI 有变化时,已检查 Dashboard 行为或截图
+- [ ] 不适用
+
+## 兼容性和数据影响
+
+- [ ] 不需要项目数据迁移
+- [ ] 现有 `.story-system/` 数据保持兼容
+- [ ] 现有 `.webnovel/` 投影保持兼容
+- [ ] 已考虑 Windows 路径和 UTF-8 行为
+- [ ] 未包含 API Key、私密小说正文或个人信息
+
+## 文档
+
+- [ ] 已更新 README 或 docs
+- [ ] 已更新命令、模板或参考资料文档
+- [ ] 已增加或更新示例
+- [ ] 不需要文档更新
+
+## Release notes
+
+<!-- 面向用户写一到两句变更说明;没有则写“无”。 -->
+