Skip to content

Commit a936311

Browse files
committed
docs: 更新 CONTRIBUTING 反映新结构 + 加英文版
- CONTRIBUTING.md 重写: - 可贡献类型分优先级:🔥 pitfalls 真实踩坑(最受欢迎)/ 技巧 / scenarios / 修正过时信息 / 翻译 - 明确文件结构:加入 cheatsheet.md, pitfalls/, templates/ 说明 - 明确 CI 会校验 link + 双语对照 - 说明 templates/ 不需要翻译(是项目专属配置) - 新增 CONTRIBUTING.en.md 英文版 - CI bilingual-parity 移除 CONTRIBUTING.md 排除(现在有英文版了)
1 parent 0127f23 commit a936311

3 files changed

Lines changed: 138 additions & 10 deletions

File tree

.github/workflows/link-check.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,11 @@ jobs:
4444
4545
# .md 没对应 .en.md
4646
while IFS= read -r -d '' file; do
47-
# 跳过不需要双语的文件:模板、license、贡献指南等
47+
# 跳过不需要双语的文件:模板、license
4848
case "$file" in
4949
*.en.md) continue;;
5050
./node_modules/*) continue;;
5151
./LICENSE*) continue;;
52-
./CONTRIBUTING.md) continue;;
5352
*/templates/*) continue;; # 配置模板是项目专属,不翻译
5453
esac
5554
en="${file%.md}.en.md"

CONTRIBUTING.en.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
[简体中文](./CONTRIBUTING.md) | **English**
2+
3+
# Contributing
4+
5+
Thanks for your interest in the AI Coding Practical Guide.
6+
7+
## What to Contribute
8+
9+
Welcome contribution types (ordered by "most valued"):
10+
11+
### 🔥 High priority: real pitfalls you've hit
12+
13+
Write a [`pitfalls/<tool>.md`](./pitfalls/README.en.md) entry for a pitfall you actually hit. **Must be real**, not speculation.
14+
15+
Format: Symptom / Cause / Recovery / Prevention. Full template in [pitfalls/README.en.md](./pitfalls/README.en.md).
16+
17+
Tools not yet covered: Windsurf / Gemini CLI / Kiro / Trae / OpenClaw.
18+
19+
### 🔥 Practical tool tips
20+
21+
Add to the "Prompt Tips" or "Advanced Usage" section of a tool's `README.en.md`. Every tip must:
22+
- Have a concrete scenario (not "this is better" but "in scenario X, Y beats Z")
23+
- Include a ❌/✅ comparison or a copy-ready prompt
24+
- Include verifiable outcomes (what was run, what was seen)
25+
26+
### ⚡ End-to-end dialogue scripts
27+
28+
Add to [`workflows/scenarios.en.md`](./workflows/scenarios.en.md). A complete runnable prompt sequence that covers an entire flow from requirement to acceptance.
29+
30+
### ⚡ Fix outdated info
31+
32+
AI tools move fast. Spot outdated content (versions, pricing, commands, feature deltas) and fix it:
33+
- [`cheatsheet.en.md`](./cheatsheet.en.md) — comparison parameters
34+
- Each `<tool>/README.en.md` — commands and hotkeys
35+
- [`ecosystem.en.md`](./ecosystem.en.md) — ecosystem project specs (role counts, features)
36+
37+
### ⚡ Translation and bilingual maintenance
38+
39+
All content has `.md` (Chinese) and `.en.md` (English) parallels. When you contribute:
40+
- Update Chinese → sync to English (draft is fine; others will polish)
41+
- Translating existing zh-only files to English is a valid contribution
42+
- Files under `templates/` **do not** need translation (they're project-specific configs)
43+
44+
CI automatically verifies every `.md` has a matching `.en.md`.
45+
46+
## Process
47+
48+
1. Fork this repo
49+
2. Create a feature branch: `git checkout -b add-xxx-tip`
50+
3. Commit your changes (Chinese or English in commit messages, either is fine)
51+
4. Push to your fork: `git push origin add-xxx-tip`
52+
5. Open a Pull Request
53+
54+
CI runs on PR:
55+
- **Link Check** — validates internal and external Markdown links
56+
- **Bilingual Parity** — ensures bilingual pairs are complete
57+
58+
If CI is red, check the Actions output and fix.
59+
60+
## Content Standards
61+
62+
- **Practical first** — every tip should have a concrete scenario, no hand-waving
63+
- **Code examples** — use ❌/✅ comparisons
64+
- **Concise** — one paragraph beats three when the content fits
65+
- **Accurate** — commands, configs, APIs must be verified, not invented
66+
- **Avoid "pitfall of pitfalls"** — don't dress up operator errors as pitfalls (e.g. "forgetting to save a file" is not a pitfall). See quality bar in [pitfalls/README.en.md](./pitfalls/README.en.md).
67+
68+
## File Layout
69+
70+
```
71+
cheatsheet.md — 9-tool cheatsheet (comparison + command reference)
72+
ecosystem.md — Related ecosystem projects (superpowers / agents / etc.)
73+
74+
<tool>/README.md — Full guide for one tool (9 tools total)
75+
<tool>/templates/ — Copy-ready config templates
76+
77+
common/xxx.md — Cross-tool methodologies (prompting / debugging / ...)
78+
workflows/xxx.md — Multi-tool workflows + real-world dialogue scripts
79+
pitfalls/<tool>.md — Deep pitfall collection per tool
80+
```
81+
82+
## License
83+
84+
Contributions are accepted under [Apache 2.0](./LICENSE).

CONTRIBUTING.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,77 @@
44

55
## 可以贡献什么
66

7-
- **补充工具技巧** — 你发现了某个工具的实用技巧,附上实际使用场景
8-
- **修正过时信息** — AI 工具更新很快,帮忙更新已经变了的内容
9-
- **分享协作经验** — 你的多工具协作工作流
10-
- **翻译** — 帮忙把内容翻译成英文或其他语言
7+
欢迎的贡献类型(按"最受欢迎"排序):
8+
9+
### 🔥 优先级高:真实踩坑的陷阱
10+
11+
[`pitfalls/<tool>.md`](./pitfalls/):你用某个工具时踩过的坑。**要求真实遇到过**,不是推测。
12+
13+
格式:症状 / 根因 / 出坑 / 预防 四段式。详细模板见 [pitfalls/README.md](./pitfalls/README.md)
14+
15+
尚未覆盖的工具:Windsurf / Gemini CLI / Kiro / Trae / OpenClaw。
16+
17+
### 🔥 实用工具技巧
18+
19+
补充 `工具名/README.md` 的"提示词技巧"或"进阶技巧"章节。每个技巧必须:
20+
- 有具体场景(不是"这样更好"而是"在 X 场景下 Y 更好")
21+
- 附 ❌/✅ 对比或可复制的提示词
22+
- 附可验证结果(跑了什么、看到什么)
23+
24+
### ⚡ 实战对话脚本
25+
26+
补充 [`workflows/scenarios.md`](./workflows/scenarios.md) 的端到端场景。一个完整可跑的提示词序列,覆盖从需求到验收的全流程。
27+
28+
### ⚡ 修正过时信息
29+
30+
AI 工具更新很快。发现过时内容(版本号、定价、命令、功能差异)请修正:
31+
- [`cheatsheet.md`](./cheatsheet.md) — 速查表的参数
32+
-`工具名/README.md` — 具体命令和快捷键
33+
- [`ecosystem.md`](./ecosystem.md) — 生态项目的角色数、功能
34+
35+
### ⚡ 翻译与双语维护
36+
37+
所有内容都有 `.md`(中文)和 `.en.md`(英文)双语。贡献时:
38+
- 更新中文 → 同步更新英文版(可以先放一个 draft,有人会帮忙 polish)
39+
- 只翻译已有中文但缺英文的文件也是有效贡献
40+
- `templates/` 目录下的配置模板**不需要**翻译(是项目专属)
41+
42+
CI 会自动校验每个 `.md` 都有配套 `.en.md`
1143

1244
## 贡献流程
1345

1446
1. Fork 本项目
1547
2. 创建 feature 分支:`git checkout -b add-xxx-tip`
16-
3. 提交修改(commit message 用中文即可
48+
3. 提交修改(commit message 用中文或英文均可
1749
4. 推送到你的 fork:`git push origin add-xxx-tip`
1850
5. 提交 Pull Request
1951

52+
PR 提交后会触发 CI:
53+
- **Link Check** — 检查 Markdown 内外链接是否有效
54+
- **Bilingual Parity** — 检查双语对照完整性
55+
56+
CI 红的话,看 Actions 输出修复即可。
57+
2058
## 内容规范
2159

2260
- **实用优先** — 每个技巧都应该有具体的使用场景,不要空谈概念
2361
- **代码示例** — 用 ❌/✅ 对比展示好坏做法
2462
- **保持简洁** — 一段话能说清楚的不要写三段
2563
- **事实准确** — 命令、配置、API 必须经过验证,不要编造
64+
- **避免"pitfall 的 pitfall"** — 写陷阱时,不要把"忘记保存文件"这种操作失误当成陷阱(详见 [pitfalls/README.md](./pitfalls/README.md) 的质量标准)
2665

2766
## 文件结构
2867

2968
```
30-
工具名/README.md — 某个工具的完整指南
31-
common/xxx.md — 通用方法论
32-
workflows/xxx.md — 多工具协作工作流
69+
cheatsheet.md — 9 工具速查表(横向对比 + 命令速查)
70+
ecosystem.md — 相关项目生态(superpowers / agents 等)
71+
72+
工具名/README.md — 某个工具的完整指南(9 个工具)
73+
工具名/templates/ — 可复制的配置模板
74+
75+
common/xxx.md — 跨工具的通用方法论(prompting / debugging 等)
76+
workflows/xxx.md — 多工具协作工作流 + 实战对话脚本
77+
pitfalls/<tool>.md — 每个工具的深度陷阱合集
3378
```
3479

3580
## 许可

0 commit comments

Comments
 (0)