跳转至

贡献指南

感谢你愿意一起完善《人工智能数学原理与算法 · 课程笔记》。本仓库欢迎纠错、补充解释、增加例子和改善导航，也重视内容来源、署名和公开许可的清晰性。

提交贡献即表示你已阅读并同意本指南及 署名规则。

可以贡献什么

  • 修正事实、公式、符号、错字和失效链接；
  • 补充直观解释、数值例子、图表、伪代码或自测题；
  • 补充不局限于单一章节、可放入 00-公共基础 的通识概念、公式和算法；
  • 新增必要的数学前置知识或 AI 专题；
  • 改善目录、双链、可访问性和 GitHub 阅读体验；
  • 补充原始论文、官方文档或权威教材等参考资料。

大规模调整目录、改变许可、删除整章或引入新的课程体系前，请先创建 Issue 讨论。小型纠错可以直接提交 Pull Request。

不应提交什么

  • 未经授权的课程讲义、教材扫描件、考试资料或作业答案；
  • 从书籍、论文、网页或其他笔记中大段复制的内容；
  • 无法确认许可来源的图片、表格和代码；
  • 个人隐私、密钥、账号信息或与本课程无关的文件；
  • 仅由生成式 AI 生成、但未经贡献者核验的内容。

可以引用少量必要内容，但应以自己的语言解释，并在“参考资料”中注明来源。第三方材料具有独立许可时，还应标明作者、原始链接和许可名称。

贡献流程

  1. Fork 本仓库，并从最新的 main 创建分支；
  2. 编辑笔记，保持改动围绕一个明确主题；
  3. 在仓库根目录运行检查：
ruby scripts/check_notes.rb
  1. 提交清晰的 commit，例如 docs: 修正 Q 学习更新公式；
  2. 创建 Pull Request，说明改动动机、主要内容和验证结果。

Pull Request 不要求一次解决整个章节。范围较小、容易复核的贡献更容易被合并。

笔记格式

新增主题笔记建议包含以下 frontmatter：

---
aliases:
  - 常用别名
tags:
  - 类型/定义
---

status 的含义为：

  • stub：只有提纲或最小定义；
  • draft：已有主体内容，但仍需内容校订；
  • reviewed：已完成一轮结构与内容复核。

新投稿通常使用 draft。只有在整篇内容经过复核后，才应标记为 reviewed。

正文建议按需要包含：一句话定义、核心公式、直观解释、数值例子、常见误区、相关笔记和参考资料。不是每篇笔记都必须机械套用全部小节。

目录约定

  • 课程章节目录命名为 NN-章节名，同名的 NN-章节名.md 是章节入口；
  • 小节文件命名为 N.M-小节名.md；
  • 多章共用的概念和算法优先放入 00-公共基础/基本概念 或 00-公共基础/算法，避免在不同章节重复定义；
  • 新增公共条目后，应在 00-公共基础/00-公共基础.md 的索引中补充入口；
  • 新建文件前先搜索文件名、alias 和相关术语，确认仓库中没有等价页面。

写作约定

  • 使用简体中文和中文标点，英文缩写首次出现时给出全称；
  • 新符号首次出现时说明含义，矩阵公式尽量标注维度；
  • 行内公式使用 $...$，展示公式的 $$ 单独占行；
  • 优先链接已有规范笔记，避免为同一概念创建重复 alias；
  • 区分事实、推导、直观类比和个人理解；
  • 不用“显然”“很简单”等措辞代替关键解释；
  • 引用优先选择原始论文、官方文档和权威教材。

Obsidian 双链使用 [[文件名|显示文字]]；公开入口和贡献文档使用标准 Markdown 链接，方便在 GitHub 上浏览。

内容准确性

提交者应对内容进行基本核验。涉及公式或算法时，建议至少完成以下一项：

  • 给出可手算的小例子；
  • 对照原始论文或权威教材；
  • 检查张量维度和边界情况；
  • 使用代码或计算工具验证结果。

维护者可能要求缩小范围、补充来源或进一步解释。讨论应围绕内容和证据，不针对贡献者个人。

许可与贡献者声明

本仓库采用 CC BY 4.0。提交 Pull Request 即表示：

  1. 你创作了该贡献，或有权按 CC BY 4.0 提交并再许可；
  2. 你同意合并后的贡献按本仓库的 CC BY 4.0 许可公开；
  3. 你保留自己贡献的著作权，不需要把版权转让给仓库维护者；
  4. 你的 Git commit、GitHub 用户名及 Pull Request 记录可用于贡献署名和版本溯源。

如果贡献包含不适用 CC BY 4.0 的第三方材料，必须在 Pull Request 和对应笔记中明确说明；未说明的内容可能被拒绝或移除。