Vibe Coding 规范

Posted on In Views:

我的 Vibe Coding 项目规范，这个文章会在我每次Vibe Code 前被喂给 Agent。

Vibe Coding 规范

  1. 项目应做成完整、成熟的 GitHub 仓库：
    • 有中英文 README，并在开头提供切换链接：[中文](README.md) | [English](README.en.md)
    • 目录结构整洁，源码放在 src/ 等目录下，避免仓库根目录杂乱
    • 有 MIT License
    • 有 .gitignore
    • README 结尾注明：本项目由 AI 和人类共同编写
  2. 项目应有测试与自动化：
    • 有单元测试
    • 有 GitHub Actions，在 push / pull request 时自动运行测试
  3. 项目应有清晰文档：
    • 说明项目用途、安装方式、使用方法
    • 给出必要的示例
  4. 如果提供命令行工具：
    • 命令结构简洁
    • 有文档说明
    • 也有 -h / --help 说明
  5. 总体要求：
    • 项目应像真正可发布、可维护、可被他人使用的 GitHub 项目，而不是临时脚本堆砌