Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
269 lines (197 loc) · 5.39 KB

CONTRIBUTING.md

File metadata and controls

269 lines (197 loc) · 5.39 KB

贡献指南

感谢你对 vibecoding-for-beginners 项目的关注! 🎉

📋 贡献范围说明

✅ 欢迎贡献的内容

1. 工具和技巧(05-tools目录)

  • 补充AI工具使用技巧
  • 实用的技巧和快捷方式
  • 工具对比和评测

如何贡献:

  • Fork 项目
  • 在 docs/guide/05-tools/ 目录添加/修改
  • 提交 Pull Request

2. 社区作品展示

  • 展示你用Vibe Coding方法做的项目
  • 分享你的实践经验
  • 案例和效果展示

如何贡献:

  • 在 docs/showcase/ 提交你的作品
  • 包含项目介绍、技术栈、链接、截图
  • 提交 Pull Request

3. 问题和Bug报告

  • 文档错误
  • 代码示例问题
  • 链接失效
  • 表述不清楚

如何报告:

  • 创建 Issue
  • 描述清楚问题和位置
  • 提供截图(如果需要)

4. 讨论和建议

  • 通过 Issues 分享经验
  • 提出改进建议
  • 回答其他人的问题

⚠️ 不接受贡献的内容

1. 核心教程内容(01-04目录)

这些内容由作者维护,保持连贯性:

  • 01-methodology/ - 方法论
  • 02-pitfalls/ - 常见错误
  • 03-case-study/ - 真实案例
  • 04-practice/ - 动手实践

为什么:

  • 方法论是个人总结,有独特视角
  • 保持内容的连贯性和一致性
  • 避免风格不统一

2. 作者专用 Skills

  • tutorial-writer - 作者的写作助手(不开放)
  • skill-creator - 可参考,但核心逻辑不接受修改

为什么:

  • tutorial-writer 是作者私人工具,风格高度定制
  • skill-creator 是元工具,需要保持稳定性

但是:

  • 可以通过 Issue 提建议
  • 指出错误和改进点
  • 作者会评估和采纳
  • 可以基于它们创建自己的版本

🎯 贡献流程

贡献工具/技巧

  1. Fork 项目
  2. 创建分支: git checkout -b add-tool-xxx
  3. 添加内容到 docs/guide/05-tools/ 对应目录
  4. 确保格式一致、内容准确
  5. 提交 PR,说明添加了什么

提交作品展示

  1. Fork 项目
  2. 在 docs/showcase/ 创建你的项目文件
  3. 使用模板(见 docs/showcase/TEMPLATE.md)
  4. 包含: 项目名、介绍、技术栈、链接、截图
  5. 提交 PR

报告问题

  1. 检查是否已有类似Issue
  2. 创建新Issue
  3. 使用清晰的标题
  4. 详细描述问题
  5. 提供复现步骤

🎯 内容贡献规范

文档风格要求

语言风格:

  • 真实分享 > 理论讲解
  • 用自己的话,不要 AI 味
  • 可以带个人观点,但要客观
  • 避免说教,多分享经验

格式要求:

  • 使用中文标点
  • 代码块指定语言
  • 合理使用标题层级
  • 提供可运行的代码示例
  • 真实案例优于虚构示例

示例:

✅ 好的写法:
我在做 AI News RSS 时,一开始想实现所有功能,后来发现...

❌ 避免的写法:
在软件开发中,我们应该遵循敏捷开发原则...

代码贡献规范

如果提交代码示例或脚本:

  • 必须能运行
  • 添加必要注释
  • 提供使用说明

✅ Pull Request 流程

提交步骤

  1. Fork 项目
  2. 创建功能分支 
    git checkout -b feat/your-contribution
  3. 进行修改
    • 添加你的内容
    • 本地测试效果(npm run docs:dev)
  4. 提交更改 
    git commit -m 'feat: add your contribution'
  5. 推送分支 
    git push origin feat/your-contribution
  6. 创建 Pull Request
    • 描述清楚改动内容
    • 关联相关 Issue(如有)
    • 说明为什么这个贡献有价值

PR 要求

必需:

  • ✅ 描述清楚改动内容
  • ✅ 本地测试通过(文档能正常显示)
  • ✅ 符合贡献规范

推荐:

  • 关联相关 Issue
  • 提供截图(如果是 UI 相关)
  • 说明测试方法

🙏 行为准则

社区氛围

  • 尊重他人
  • 友好交流
  • 建设性反馈
  • 包容不同观点

关于内容决策

  • 核心方法论由作者维护(保持连贯性)
  • 工具技巧和作品展示欢迎贡献
  • 如有不同意见,欢迎友好讨论
  • 尊重最终决定

📞 联系方式

💡 贡献理念

为什么有些内容不开放贡献?

核心方法论(作者维护):

  • 保持系统性和连贯性
  • 统一的风格和视角
  • 基于个人实践的总结

这不是"拒绝贡献",而是"明确定位"

  • 核心方法论 = 作者的独特视角
  • 你的贡献 = 丰富课程生态

你的贡献同样重要!

工具技巧(欢迎贡献):

  • 每个人的使用经验不同
  • 工具更新快,需要社区补充
  • 实践出真知

作品展示(欢迎贡献):

  • 证明方法论的有效性
  • 激励其他学员
  • 形成良性社区

Skills 贡献（欢迎贡献）:

  • 补充 6 个框架 Skills 的真实案例
  • 创建新的 Skills(基于课程方法论)
  • 改进框架 Skills 的提示词

🎯 如何让贡献更有价值?

1. 分享真实经验

✅ 有价值:
"我用 Cursor 做项目时,发现..."
"我踩了这个坑,后来这样解决..."

❌ 价值低:
"根据官方文档,我们应该..."
"理论上来说..."

2. 提供具体案例

  • 真实项目经验
  • 具体问题和解决方案
  • 优化前后对比数据

3. 保持真实和客观

  • 不夸大效果
  • 不隐瞒问题
  • 分享失败经验同样有价值

再次感谢你的贡献!

记住: 不是所有内容都需要贡献,但你的真实经验和作品,我们很期待!