跳转至

贡献指南

欢迎修正事实、补充可复现练习和解释工程取舍。优先改好现有问题,再增加题量。

  1. 问题需有稳定编号 ### Q093 问题标题,编号不复用;每题包含短答、详细答案、三个带回答的追问、实战案例、误区、可验证练习及学习章双向链接。
  2. 事实给一手来源与必要的版本范围;工程建议说明适用条件。
  3. 题目不得假称来自特定企业,不提交未获许可的面经、付费内容、公司资料、客户数据或真实密钥。
  4. 实验区分 mock、真实模型结果和未实现项;不把个人练习写成生产履历。
  5. 扩充题目时更新 scripts/check_repo.py 的题目总量与学习映射,并运行索引生成与检查。--write-index 会同时更新总索引及基础学习章的相关题目导航,正文和导航区外的笔记保留。
python3 scripts/check_repo.py --write-index
python3 scripts/check_repo.py
python3 -m unittest discover -s tests -v

PR 说明修正了什么、来源是什么、怎样验证。新的学习记录默认放入自己的 .local/,分享时先脱敏。外部项目只引用链接和短摘要;复制任何代码/图像前核对原项目授权并保留要求的声明。

基础课程应在相关段落附近给一手来源与适用条件,并同步更新 learning/verification.md 中的参考资料。新增数值算例要可独立复算,新增可运行代码块应实际执行;来源项目的归档、接口版本和示例工具类型应说明清楚。

写得容易读,也容易记

章节先给一个读者会遇到的问题,再跟着输入、状态和结果解释机制。引入术语时说清它在案例中做什么;长功能清单更适合放参考资料,不要让它占据正文的主线。

类比可以轻松一些,但要说清映射和边界。例如把幂等键比作同一笔业务的取件凭条,能帮助解释重复请求返回原结果;仍需补上服务端原子记录、内容核对与有效期。笑点应帮助理解,不能代替技术条件。

正文通常每段 2–4 句,长因果链按动作拆段。用默认正文讲解,行内代码标识字段和命令;只给重要结论加粗。比较才用表格,步骤才用列表,公式与算例各留独立空行。详细答案可用 <details markdown="1"> 折叠,内部保留空行,并闭合标签。

GitHub 统一控制页面字体和行距,Markdown 正文不插入字体标签或 CSS。在线手册的阅读样式集中放在 website/assets/,由同一份 Markdown 自动生成,发布和本地预览见 网站维护说明。保持标题层级、短段落、清楚的链接文字和代码语言标记,让电脑与手机都能按同一阅读顺序使用。润色时保留题号与题目标题,避免破坏已分享的锚点。

阅读建议直接写成“建议先读哪一章、先了解什么”,并链接具体章节。少用没有解释的“先修”“前置”,让读者知道阅读顺序及其理由。