Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
246 lines (177 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

246 lines (177 loc) · 4.04 KB

🤝 贡献指南

感谢你考虑为 Claude Code 学习资料库做贡献！

🌟 贡献方式

1. 报告问题

  • 🐛 发现错误 → 提 Issue
  • 💡 有建议 → 开 Discussion
  • 📝 内容改进 → 提 PR

2. 贡献内容

  • 📚 新增学习资料
  • 🔧 改进现有文档
  • 🌐 翻译文档
  • 🎨 优化排版

3. 社区参与

  • 💬 回答问题
  • 👥 帮助新手
  • 📢 分享经验
  • 🎓 指导学习

📝 贡献流程

Step 1: Fork 仓库

# 在 GitHub 上 Fork 这个仓库

Step 2: 克隆到本地

git clone https://github.com/YOUR_USERNAME/claude-code-learning.git
cd claude-code-learning

Step 3: 创建分支

git checkout -b feature/your-feature-name

Step 4: 做出修改

# 编辑文件
# 添加新文件
# 改进现有内容

Step 5: 提交更改

git add .
git commit -m "🎯 简短描述你的修改"

Step 6: 推送到 GitHub

git push origin feature/your-feature-name

Step 7: 创建 Pull Request

  • 在 GitHub 上创建 PR
  • 描述你的修改
  • 等待审核

📋 内容规范

文件命名

  • 使用小写字母和连字符
  • 例如：learning-guide.md
  • 避免空格和特殊字符

Markdown 格式

# 主标题

简要描述

## 二级标题

### 三级标题

- 列表项1
- 列表项2

**粗体** *斜体* `代码`

\`\`\`python
# 代码块
print("Hello")
\`\`\`

代码示例

  • 提供可运行的代码
  • 添加必要注释
  • 说明运行环境

链接引用

[链接文字](文件名.md)

🎯 贡献类型

高优先级

  • 🔥 燃烧文档系列扩展
  • 📚 学习路径优化
  • 🎯 实战项目案例
  • ❓ FAQ 完善

中优先级

  • 📖 文档改进
  • 🌐 多语言支持
  • 🎨 排版优化
  • 📊 图表绘制

低优先级

  • 🧹 代码格式统一
  • 📝 拼写错误修正
  • 🔗 链接检查
  • 📁 目录整理

✅ 质量标准

内容质量

  • ✅ 准确性：信息正确无误
  • ✅ 完整性：内容全面完整
  • ✅ 实用性：可直接应用
  • ✅ 可读性：易于理解

代码质量

  • ✅ 可运行：代码能正常执行
  • ✅ 有注释：关键部分有说明
  • ✅ 有测试：包含测试用例
  • ✅ 遵循规范：符合编码标准

文档质量

  • ✅ 结构清晰：层次分明
  • ✅ 语言简洁：表达清晰
  • ✅ 格式统一：符合规范
  • ✅ 链接有效：无死链

🔍 审核流程

自动检查

  • Markdown 语法检查
  • 链接有效性检查
  • 文件命名规范检查

人工审核

  1. 内容准确性
  2. 格式规范性
  3. 价值贡献度
  4. 社区适用性

审核时间

  • 小修改：1-3天
  • 新内容：3-7天
  • 大改动：7-14天

🎖️ 贡献者奖励

Bronze 贡献者

  • 1-5个 PR 合并
  • 获得 Bronze 徽章

Silver 贡献者

  • 6-20个 PR 合并
  • 获得 Silver 徽章
  • 加入贡献者名单

Gold 贡献者

  • 21+个 PR 合并
  • 获得 Gold 徽章
  • 成为项目维护者

📞 联系方式

GitHub

邮件

  • 项目维护者: [查看 GitHub Profile]

🙏 致谢

感谢所有贡献者的付出！

📜 行为准则

我们的承诺

  • 尊重所有贡献者
  • 接受建设性批评
  • 关注社区利益
  • 保持友善态度

禁止行为

  • 骚扰或歧视
  • 发布不当内容
  • 恶意破坏
  • 商业推广

🔄 更新日志

  • 2026-03-23: 创建贡献指南

📚 相关资源

开始贡献吧！ 🚀

我们期待你的第一个 PR！

最后更新: 2026-03-23 09:06 AM