GitHub Issue需标题括号标场景、正文首句说预期与实际、步骤用动词短句分行、环境信息固定格式代码块;飞书文档用“你试试看”拉近距离或嵌入截图锚点;Jira按测试用例格式写前置条件、操作步骤、预期与实际结果。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

当你在不同平台(比如GitHub Issue、飞书文档、内部Bug跟踪系统)提交Codeium插件报错复现步骤时,原始提示词常因语气生硬、信息堆砌或缺少上下文而被开发同学跳过阅读。你需要把“请复现以下步骤”这种命令式表达,替换成符合该平台沟通习惯的自然句式,让问题描述一眼可读、关键动作清晰、环境信息不遗漏。
GitHub Issue中改写复现步骤
第一步:在标题末尾加括号注明触发场景,例如「【Codeium 4.12.0】输入中文后自动补全卡死」——【不写版本号和触发动作,开发者无法快速定位是哪个功能路径出的问题】。
第二步:正文开头用一句话说明「我预期什么发生,实际发生了什么」,比如:“期望按 Ctrl+Enter 触发补全,结果编辑器无响应且 CPU 占用飙升至95%”。
第三步:复现步骤用纯动词开头的短句分行罗列,每行只做一件事,不加主语、不套话:
• 打开一个 .py 文件
• 输入 def test_ 后停顿1秒
• 按 Ctrl+Enter
• 观察状态栏是否显示「Codeium: Processing…」并持续超过10秒
第四步:贴出关键环境信息,格式固定为代码块,字段顺序不能乱:
```
OS: macOS Sonoma 14.5
VS Code: 1.89.2
Codeium Extension: 4.12.0
Language Server Status: Running (pid 12345)
```
飞书文档内改写复现步骤
方法一:用「你试试看」开头拉近距离,适合同步给同事快速验证:
你试试看——打开 VS Code → 新建空白 .js 文件 → 输入 console. → 等待3秒 → 这时Codeium弹出的补全框里全是乱码符号(如 □□□),不是函数名。
方法二:嵌入截图锚点,文字只说「哪里点、点什么、等多久、看哪」:
见图1红框处:点击右下角「Codeium」状态图标 → 点「Restart Language Server」→ 等待进度条走完 → 看顶部通知栏是否出现「Restarted successfully」。如果没出现,而是弹出「Connection refused」错误,就是复现成功。
内部Bug系统(如Jira)填写复现步骤
直接写成可执行的测试用例格式,字段严格对齐:
前置条件:已登录Codeium账号,VS Code设置中启用「Auto-trigger completions」
操作步骤:
1. 在 TypeScript 文件中输入 fetch('
2. 等待500ms(不要继续输入)
3. 观察悬浮补全面板是否出现带「→」箭头的HTTP方法建议项
预期结果:面板显示 fetch('GET', 'POST', 'PUT' 等可选方法
实际结果:面板空白,DevTools Console 报错「TypeError: Cannot read property 'map' of undefined」

















