CONTRIBUTING.md

贡献指南

感谢你对 Clacky AI 编程入门教程项目的关注！我们欢迎各种形式的贡献，包括但不限于：

🤝 如何贡献

📝 内容贡献

1. 改进教程内容

   • 修正错误或不准确的信息
   • 补充缺失的内容
   • 优化表达方式和结构

2. 添加新的练习项目

   • 设计适合初学者的项目
   • 提供完整的项目说明和代码

3. 翻译工作

   • 将教程翻译成其他语言
   • 维护多语言版本的同步

🐛 问题报告

如果你发现了问题，请：

1. 检查是否已有相关的 Issue
2. 创建新的 Issue，包含：
   • 问题的详细描述
   • 重现步骤
   • 期望的行为
   • 实际的行为
   • 环境信息（浏览器、操作系统等）

💡 功能建议

我们欢迎新功能的建议：

1. 创建 Feature Request Issue
2. 详细描述建议的功能
3. 说明功能的用途和价值
4. 如果可能，提供实现思路

🚀 提交流程

1. Fork 项目

点击项目页面右上角的 "Fork" 按钮，将项目复制到你的 GitHub 账户。

2. 克隆到本地

git clone https://github.com/你的用户名/ai-clacky-workshop-tutorial.git
cd ai-clacky-workshop-tutorial

3. 创建分支

git checkout -b feature/你的功能名称
# 或
git checkout -b fix/你的修复名称

4. 进行修改

• 遵循项目的代码风格
• 确保修改不会破坏现有功能
• 添加必要的测试

5. 提交更改

git add .
git commit -m "描述你的更改"

6. 推送到 GitHub

git push origin feature/你的功能名称

7. 创建 Pull Request

1. 访问你的 Fork 项目页面
2. 点击 "New Pull Request"
3. 填写 PR 描述，包括：
   • 更改的内容
   • 更改的原因
   • 测试情况

📋 代码规范

Markdown 文档

• 使用中文标点符号
• 代码块使用适当的语言标识
• 保持一致的标题层级
• 使用有意义的链接文本

文件命名

• 使用中文文件名（如现有文件）
• 保持命名的一致性
• 避免特殊字符

提交信息

使用清晰的提交信息：

类型: 简短描述

详细描述（如果需要）

- 具体更改1
- 具体更改2

类型包括：

• feat: 新功能
• fix: 修复
• docs: 文档更新
• style: 格式调整
• refactor: 重构
• test: 测试相关

🎯 学员作品提交

提交你的学习作品

完成教程学习后，欢迎提交你的作品到学员作品展示区：

1. 在 student-works 目录下创建你的文件夹
2. 文件夹命名格式：你的名字-城市（如：张三-北京）
3. 包含以下文件：
   • README.md - 项目介绍
   • index.html - 项目主页（如果适用）
   • 其他项目文件

作品要求

• 必须是通过本教程学习完成的项目
• 代码整洁，有适当的注释
• 包含项目说明和使用方法
• 如果有在线演示，请提供链接

作品展示格式

在你的 README.md 中包含：

# 项目名称

## 作者信息
- 姓名：你的名字
- 城市：你的城市
- 学习时间：完成教程的时间

## 项目描述
简要描述你的项目功能和特色

## 技术栈
- 使用的技术和工具

## 在线演示
- 项目链接（如果有）

## 学习心得
分享你的学习体验和收获

## 项目截图
![项目截图](screenshot.png)

🔍 代码审查

所有的 Pull Request 都会经过代码审查：

1. 自动化检查（如果配置）
2. 维护者人工审查
3. 社区反馈

请耐心等待审查结果，并根据反馈进行调整。

📞 联系我们

如果你有任何问题或建议：

• 创建 GitHub Issue
• 发送邮件到：support@clacky.ai
• 参与社区讨论

🏆 贡献者认可

我们会在项目中认可所有贡献者：

• 在 README 中列出贡献者
• 在发布说明中感谢贡献者
• 为重要贡献者提供推荐信

📄 许可证

通过贡献代码，你同意你的贡献将在 MIT 许可证下发布。

---

再次感谢你的贡献！让我们一起让这个教程变得更好！ 🎉