问题报告系统

相关源文件

• .github/ISSUE_TEMPLATE/01-algo-website-bug.md
• .github/ISSUE_TEMPLATE/02-algo-visualize-bug.md
• .github/ISSUE_TEMPLATE/03-chrome-extension-bug.md
• .github/ISSUE_TEMPLATE/04-vscode-extension-bug.md
• .github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md
• .github/ISSUE_TEMPLATE/06-suggestion.md

目的与范围

本文档详细介绍了 fucking-algorithm 仓库中实现的结构化问题报告系统。该系统为报告生态系统中不同组件的 bug 和提交功能建议提供了专门的模板。有关通过拉取请求（pull requests）进行贡献的信息，请参阅 贡献系统。

问题模板概览

该仓库通过六个专门的 GitHub 问题模板，实施了结构化的报告流程。每个模板都旨在收集与生态系统不同组件相关的具体信息。

可用问题模板

模板名称	目的	负责人	标签
网站 bug	用于报告 labuladong.online 网站上的 bug	labuladong	algo-websie-bug
算法可视化 bug	用于报告算法可视化工具中的 bug	labuladong	algo-visualize-bug
Chrome 扩展 bug	用于报告 Chrome 扩展中的 bug	labuladong	algo-website, chrome-extension-bug
VSCode 扩展 bug	用于报告 VSCode 扩展中的 bug	labuladong	vscode-extension-bug
JetBrain 插件 bug	用于报告 JetBrains 插件中的 bug	labuladong	jb-plugin-bug
建议	用于为项目提出想法或改进建议	labuladong	feature-request

来源：.github/ISSUE_TEMPLATE/01-algo-website-bug.md .github/ISSUE_TEMPLATE/02-algo-visualize-bug.md .github/ISSUE_TEMPLATE/03-chrome-extension-bug.md .github/ISSUE_TEMPLATE/04-vscode-extension-bug.md .github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md .github/ISSUE_TEMPLATE/06-suggestion.md

问题报告工作流程

下表展示了该仓库的问题报告工作流程

来源：.github/ISSUE_TEMPLATE/01-algo-website-bug.md .github/ISSUE_TEMPLATE/02-algo-visualize-bug.md .github/ISSUE_TEMPLATE/03-chrome-extension-bug.md .github/ISSUE_TEMPLATE/04-vscode-extension-bug.md .github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md .github/ISSUE_TEMPLATE/06-suggestion.md

模板结构和所需信息

每个问题模板都旨在收集与相应组件故障排除相关的特定信息。以下是每个模板请求的信息摘要：

网站 bug 模板结构

网站 bug 模板 (01-algo-website-bug.md) 要求提供：

• 网络状况（中国网络或全球网络）
• bug 描述
• 截图（如果适用）
• 平台信息（手机或电脑）
• 网页浏览器信息（Chrome、Edge 等）

来源：.github/ISSUE_TEMPLATE/01-algo-website-bug.md10-21

算法可视化 bug 模板结构

算法可视化 bug 模板 (02-algo-visualize-bug.md) 似乎是一个最小化模板，除了基本的模板结构外，没有定义特定的字段。

来源：.github/ISSUE_TEMPLATE/02-algo-visualize-bug.md10-11

Chrome 扩展 bug 模板结构

Chrome 扩展 bug 模板 (03-chrome-extension-bug.md) 要求提供：

• bug 描述
• 截图（如果适用）
• 网页浏览器信息（Chrome、Edge 等）

来源：.github/ISSUE_TEMPLATE/03-chrome-extension-bug.md10-17

VSCode 扩展 bug 模板结构

VSCode 扩展 bug 模板 (04-vscode-extension-bug.md) 要求提供：

• 扩展版本信息
• bug 描述
• 截图（如果适用）

来源：.github/ISSUE_TEMPLATE/04-vscode-extension-bug.md10-17

JetBrain 插件 bug 模板结构

JetBrain 插件 bug 模板 (05-jetbrain-plugin-bug.md) 要求提供：

• 插件版本信息
• bug 描述
• 截图（如果适用）

来源：.github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md10-17

建议模板结构

建议模板 (06-suggestion.md) 提出：

• 对项目的总体建议
• 关于项目不便之处的咨询

来源：.github/ISSUE_TEMPLATE/06-suggestion.md10-13

问题跟踪和解决系统

下图说明了问题是如何被跟踪并映射到生态系统的不同组件的

来源：.github/ISSUE_TEMPLATE/01-algo-website-bug.md5-6 .github/ISSUE_TEMPLATE/02-algo-visualize-bug.md5-6 .github/ISSUE_TEMPLATE/03-chrome-extension-bug.md5-6 .github/ISSUE_TEMPLATE/04-vscode-extension-bug.md5-6 .github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md5-6 .github/ISSUE_TEMPLATE/06-suggestion.md5-6

问题解决流程

问题解决流程遵循以下一般步骤：

来源：.github/ISSUE_TEMPLATE/01-algo-website-bug.md6 .github/ISSUE_TEMPLATE/02-algo-visualize-bug.md6 .github/ISSUE_TEMPLATE/03-chrome-extension-bug.md6 .github/ISSUE_TEMPLATE/04-vscode-extension-bug.md6 .github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md6 .github/ISSUE_TEMPLATE/06-suggestion.md6

问题模板结构详情

下图提供了 GitHub 问题模板结构的详细视图。

来源： .github/ISSUE_TEMPLATE/01-algo-website-bug.md1-22 .github/ISSUE_TEMPLATE/02-algo-visualize-bug.md1-11 .github/ISSUE_TEMPLATE/03-chrome-extension-bug.md1-18 .github/ISSUE_TEMPLATE/04-vscode-extension-bug.md1-18 .github/ISSUE_TEMPLATE/05-jetbrain-plugin-bug.md1-18 .github/ISSUE_TEMPLATE/06-suggestion.md1-13