【项目名:use-debounce-vue;版本:3.1.0;简介:Vue 3 组合式 API 防抖 Hook,自动清理 setTimeout;主入口:./dist/index.js】快速开始:cd ./ && npm install && npm test
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要一份能直接提交到 GitHub 主分支、被新成员 clone 后五分钟内跑起来的 README,不是草稿、不是内部笔记、不是带占位符的模板——所有路径、命令、版本号、截图标记都必须真实可验证,漏一个斜杠或错一个大小写就会让新人卡在第一步。
锁定真实项目元数据并注入提示词
打开项目根目录下的 package.json(Node.js)或 pyproject.toml(Python),复制 name、version、description 三字段值;若为前端库,额外取 exports 字段中 main 或 types 的实际路径(如 ./dist/index.js)。
在 Codeium 提示词开头第一句,用冒号分隔方式写死这四条信息:【项目名:use-debounce-vue;版本:3.1.0;简介:Vue 3 组合式 API 防抖 Hook,自动清理 setTimeout;主入口:./dist/index.js】。不加“例如”“类似”,不写“可根据实际情况调整”——Codeium 读到模糊表述会默认填充通用占位符。
这一步不做,生成的安装命令里可能出现 npm install use-debounce-vue@latest(实际未发布)或 import { useDebounce } from 'use-debounce-vue'(实际需指定子路径)。
强制输出含可验证命令链的“快速开始”段落
方法一:显式声明执行路径约束
在提示词中写:“‘快速开始’段落必须包含三行可逐行复制粘贴执行的命令,且满足:① 第一行是 cd 到项目根目录(路径用 ./ 表示,不写 ~/my-project);② 第二行是安装命令(npm install / pip install -e . / cargo build ——严格匹配项目实际包管理器);③ 第三行是验证命令(npm test / python -m pytest tests/ / cargo test ——必须与项目真实测试入口一致)。”
方法二:绑定 CI 状态检查
追加一句:“若项目根目录存在 .github/workflows/ci.yml,则第三行验证命令末尾添加 && echo ‘✅ CI 通过后此命令必成功’;若不存在,删除该 echo 部分。”
注意:不要写“运行测试确认功能正常”这种模糊描述,Codeium 会生成空泛句子。必须给出具体命令字符串,它才能校验语法合法性。
生成后立即执行三项硬性校验
第一步:检查所有路径是否含相对定位符
全文搜索 ./、../、src/、dist/ 等真实路径片段,删掉所有绝对路径(如 /home/user/project)和无上下文路径(如 lib/ ——没说明是 src/lib 还是 node_modules/lib)。
第二步:验证命令块是否可直执行
把生成的“快速开始”三行命令复制进终端,逐行执行。若第二行 pip install -e . 报错 ModuleNotFoundError: No module named 'setuptools',说明提示词未要求补全依赖安装步骤,需退回重写。
第三步:比对 package.json 中 scripts 字段
提取 scripts.test 值(如 "test": "vitest"),将生成文档中对应命令替换为 vitest ——不能保留“运行测试”文字描述,必须是终端里敲回车就执行的精确字符串。
















