CONTRIBUTING.md

贡献指南

感谢你想让这个「架构知识库」变得更好!无论是加模板、补真实案例,还是翻译,都非常欢迎。

你可以贡献什么

• 🗺️ 新的架构模板(最受欢迎)
• 📚 教程的改进、纠错、补充真实案例
• 🌍 英文译文的校对与打磨(全站 31 个模板已中英双语,欢迎改进译文质量)
• ✏️ 修正错误、改进措辞

加一个新模板

1. 复制 templates/_TEMPLATE.md 到 templates/<your-system>/README.md。
2. 把 14 段逐一填满。铁律:只讲架构,不讲语言 / 框架 / 具体库。 一旦你写下「用 XX 语言的 YY 库」,就停下来问自己:这是架构决策,还是实现细节?
3. 图一律用 ASCII(纯文本、到处能看、永不失效)。
4. 第 14 段「参考原型」必须给真实、查证过的链接(官方开源仓库 / 工程博客 / 论文)——绝不编造或凭记忆猜 URL。
5. 在 templates/README.md 和根 README(中英)的清单表里各加一行。

验收标准:一个没接触过这个领域的工程师,读完你的模板,能讲清「这类系统为什么这么设计、会死在哪」。

本地预览

pnpm install
pnpm docs:dev     # 本地起交互站,边写边看
pnpm docs:build   # 构建——会【严格检查死链】,必须通过

提 PR

• 一个 PR 聚焦一件事;标题说清你改了什么。
• 确保 pnpm docs:build 通过(无死链) —— CI 也会自动检查。
• 中文为主;每个设计都要能回答「为什么」和「代价是什么」。

配套

把知识变成 AI 引导 skill 的搭档仓库:architecture-copilot。