Tutorial ｜贡献到 Claude Code¶

难度：⭐⭐⭐ 时间：~1h 前置：基本 GitHub 工作流产物：成功提交 PR 到 dvxiaofan/cc-claude-code

1. 仓库状态¶

仓库：dvxiaofan/cc-claude-code（GitHub 公开）注意：这是 2026-03-31 泄露事件后的快照仓库

贡献类型： - 文档补充（learn_doc/） - 错误修正 - 翻译 - 教程贡献

⚠️ 本仓库无 package.json —— 不能本地跑测试。

2. 4 步贡献流程¶

2.1 Fork 仓库¶

# GitHub UI: Fork
git clone https://github.com/<your-username>/cc-claude-code
cd cc-claude-code
git remote add upstream https://github.com/dvxiaofan/cc-claude-code

Fork。

2.2 创建分支¶

git checkout -b docs/add-bash-parser-deep-dive

分支命名： - docs/<topic> —— 文档 - fix/<desc> —— 错误 - feat/<desc> —— 新功能

2.3 提交¶

git add learn_doc/topics/deep-dive-bash-parser.md
git commit -m "docs: 添加 bashParser.ts 深度拆解

- 21 章，~500 行
- 覆盖 79 个 parseXxx 函数
- 关键洞察：50ms UX 阈值 / 3449 黄金语料库"
git push origin docs/add-bash-parser-deep-dive

commit 规范（参考 commit history）： - docs: —— 文档 - feat: —— 新功能 - fix: —— 修复 - chore: —— 元数据 - 主题：动词 + 内容 - 50 字以内

2.4 提 PR¶

# GitHub UI: Compare & Pull Request

PR 模板：

## 描述
简要描述改了什么

## 关联 Issue
Closes #123 (如果有)

## 类型
- [ ] 文档补充
- [ ] 错误修正
- [ ] 翻译
- [ ] 教程
- [ ] 其他

## 检查
- [ ] 在本地看过效果（文档类）
- [ ] commit message 规范
- [ ] 单一关注点（不混合）

PR 模板。

3. 5 类贡献¶

3.1 文档补充¶

添加 deep-dive
添加 tutorial
添加 walkthrough
添加 visualization
添加 analysis

learn_doc/ 子目录： - topics/ —— 主题 - tutorials/ —— 教程 - walkthrough/ —— 练习答案 - data/ —— 可视化 - analysis/ —— 分析 - reference/ —— 速查 - glossary.md —— 术语 - README.md —— 入口 - SUMMARY.md —— 目录

3.2 错误修正¶

# 1. 找到错
# 2. 修
# 3. 提 PR

3 步。

3.3 翻译¶

# 当前全英文
# 翻译成中文 / 日文 / etc.

翻译。

3.4 教程¶

实战指南
视频脚本
最佳实践

教程。

3.5 工具脚本¶

# 推测：仓库根允许一些工具脚本
gen-md, validate, ...

工具。

4. commit 规范¶

4.1 type¶

docs:   文档
feat:   新功能
fix:    修复
chore:  元数据
test:   测试
refactor: 重构

6 种 type。

4.2 格式¶

<type>: <subject>

<body>

<footer>

3 段。

4.3 例子¶

docs: 修复 32 个文件里的 anchor warnings（48 → 1）

- 修改 32 个文件
- 改 `../` 为 `../../docs/`
- 保留 1 个无法修复

Closes #42

完整。

4.4 ❌ 不要¶

# ❌ 太简单
Update

# ❌ 太多类型混合
feat+fix+docs: 很多东西

# ❌ 主体过长
docs: 这是一个很长很长的 commit message 一直写下去...

# ❌ Co-Authored-By Claude
Co-Authored-By: Claude

4 个反模式。

5. 文档贡献规范¶

5.1 文件位置¶

learn_doc/
├── README.md              ← 入口
├── SUMMARY.md             ← 目录
├── glossary.md            ← 术语
├── how-to-read-500k-loc.md
├── video-script.md
├── PR-IDEAS.md
├── topics/                ← 主题
├── tutorials/             ← 教程
├── walkthrough/           ← 练习
├── data/                  ← 可视化
├── analysis/              ← 分析
├── reference/             ← 速查
└── phase-0X-*.md          ← 阶段

13 目录/文件。

5.2 命名¶

deep-dive-<name>.md       # 深度拆解
<topic>-<sub>.md          # 专题
<verb>-<noun>.md          # 教程（build-plugin.md）
<subject>.md              # 分析（performance-history.md）

4 种模式。

5.3 Frontmatter（推荐）¶

---
title: 文件名
重要性: ⭐⭐⭐⭐
时间: ~2h
前置: [topic-x.md]
---

4 字段。

5.4 内部结构¶

# 标题
> 重要性 / 时间 / 前置 / 产物

## 1. 概念
## 2. ...
## N. 关键洞察
## 阅读清单
## 练习任务

5+ 段。

6. PR 流程¶

6.1 创建 PR¶

gh pr create --title "docs: add bash parser deep dive" --body "..."

gh CLI。

6.2 等待 review¶

gh pr status

状态。

6.3 响应 review¶

# 改完 push
git add .
git commit -m "fix: 调整章节顺序"
git push origin branch

改完 push。

6.4 Merge¶

# Maintainer 合并
gh pr merge <id> --squash

squash 合并。

7. ⚠️ 注意事项¶

7.1 不能跑测试¶

# ❌ 失败
npm install
npm test

# ✅ 跳过（无 package.json）

无 package.json。

7.2 纯代码改动¶

# 1. 修改 src/
# 2. ⚠️ 风险大
# 3. 需要 maintainer 验证

谨慎。

7.3 Commit 规范¶

# ✅ 加 Co-Authored-By Claude 是被禁止的
# 用户偏好：不加 AI 署名

无 AI 署名。

8. 5 个 PR Idea¶

参考 PR-IDEAS.md：

更多 deep-dive —— 还有 17+ 文件没拆
更多 tutorial —— 实战指南
i18n 翻译 —— 中文版
可视化 —— mermaid 流程图
错误修正 —— 拼写 / 链接 / 引用

5 个方向。

9. 提交后¶

9.1 等待 review¶

可能 1-7 天。

9.2 修改¶

按 reviewer 意见改。

9.3 Merge¶

Squash merge → 自动关闭。

10. 下一步¶

Fork 仓库
写一个 deep-dive
提 PR

Tutorial ｜ 贡献到 Claude Code¶