如何在 GitHub 上为 CodeGPT 记录问题
请按照以下指南在 CodeGPT 仓库中创建新问题,以确保问题得到有效沟通和解决。
⚠️ 警告: 不遵循这些指南的问题可能不会被考虑。⚠️
记录问题的步骤
检查现有问题
- 在创建新问题之前,请检查现有问题,以确保您的问题尚未被报告。
打开一个新问题
- 导航到 CodeGPT 仓库的 问题标签。
- 点击
New issue
按钮。
选择问题类型
- 选择最能描述您问题的适当问题模板:
- Bug 报告
- 功能请求
- 文档改进
- 其他
- 选择最能描述您问题的适当问题模板:
填写问题模板
- 标题:提供一个清晰简洁的标题。
- 描述:详细描述问题,包括:
- 重现步骤:提供逐步描述如何重现问题。
- 预期行为:描述您期望发生的情况。
- 实际行为:描述实际发生的情况。
- 截图:如果适用,附上截图。
- 环境:包括问题发生的相关环境信息:
- 操作系统(例如,Windows,macOS,Linux)
- 浏览器(如果适用)
- CodeGPT 版本
- 其他相关细节
附加信息
- 日志:提供任何相关的日志消息或错误代码。
- 解决方法:如果您找到任何解决方法,请提及。
- 参考:链接到任何相关的问题或讨论。
提交问题
- 检查您的问题,确保包含所有必要信息。
- 点击
Submit new issue
按钮。
示例问题模板
以下是一个记录良好的问题示例:
Bug 报告
标题: CodeGPT 在打开大文件时崩溃
描述: 当我尝试在 CodeGPT 中打开一个大文件(超过 20MB)时,应用程序立即崩溃。
重现步骤:
- 打开 CodeGPT。
- 转到
File
>Open
。 - 选择一个大于 20MB 的文件。
- 点击
Open
。
预期行为: CodeGPT 应该在不崩溃的情况下打开大文件。
实际行为: CodeGPT 崩溃,并显示错误消息 "Application has stopped working."
截图: 错误截图
环境:
- 操作系统:Windows 10
- CodeGPT 版本:1.2.3
- 内存:16GB
- 处理器:Intel i7
日志:
解决方法: 没有已知的解决方法。
参考: 相关问题:#123
有效报告问题的提示
- 具体:提供尽可能多的细节,以帮助我们理解和重现问题。
- 保持主题:每个报告专注于一个问题。如果您有多个问题,请为每个问题创建单独的报告。
- 跟进:如果有更多信息,请更新问题以提供新细节。
通过遵循这些指南,您将帮助我们改进 CodeGPT。感谢您的贡献!