Skip to content

贡献指南

Jump to bottom
tukuaiai edited this page Dec 18, 2025 · 2 revisions

🤝 贡献指南

感谢你对 Vibe Coding 项目的关注！我们欢迎各种形式的贡献。

贡献方式

1. 提交 Issue

  • Bug 报告 - 发现问题请告诉我们
  • 功能建议 - 有好想法请分享
  • 文档改进 - 发现错误或不清楚的地方
  • 提示词贡献 - 分享你的好用提示词

👉 创建 Issue

2. 提交 Pull Request

  1. Fork 本仓库
  2. 创建你的分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'feat: 添加某功能')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 创建 Pull Request

3. 参与讨论

贡献内容指南

提示词贡献

提示词是本项目的核心资产，欢迎贡献！

格式要求：

# 提示词名称

> 一句话描述用途

---

## 使用场景
[描述适用场景]

## 提示词内容

[提示词正文]


## 使用示例
[效果展示]

## 注意事项
[使用技巧或限制]

存放位置：

  • 系统提示词 → i18n/zh/prompts/system_prompts/
  • 编程提示词 → i18n/zh/prompts/coding_prompts/
  • 用户提示词 → i18n/zh/prompts/user_prompts/

实战案例贡献

格式要求：

# 实战案例：项目名称

> 难度：⭐⭐ | 预计时间：X 小时 | 技术栈：XXX

## 🎯 项目目标
## 📋 开始前的准备
## 🏗️ 项目结构
## 🔧 核心代码
## 🚀 部署/使用
## ✅ 验收清单
## 💡 进阶挑战

存放位置： i18n/zh/documents/实战案例/

文档贡献

  • 修复错别字和语法错误
  • 改进表述清晰度
  • 补充缺失内容
  • 更新过时信息

代码规范

Commit 信息格式

<type>: <description>

[optional body]

Type 类型：

  • feat - 新功能
  • fix - 修复
  • docs - 文档
  • chore - 杂项
  • refactor - 重构

示例：

feat: 添加调试专家提示词
docs: 更新 README 快速开始部分
fix: 修复链接失效问题

文件命名

  • 中文文档使用中文命名
  • 代码文件使用英文小写 + 连字符
  • 提示词文件使用描述性名称

审核流程

  1. 提交 PR 后，CI 会自动检查
  2. 维护者会在 1-3 天内审核
  3. 可能会有修改建议
  4. 通过后合并到主分支

行为准则

请阅读我们的 行为准则，确保友好、尊重的交流环境。

联系方式

感谢你的贡献！🙏

返回主仓库 | 最后更新于：{{ "now" | date: "%Y-%m-%d %H:%M" }}

Clone this wiki locally