|
| 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). |
0 commit comments