贡献流程

• 提交贡献申请
• Fork review-notes-dev (opens new window) 后在本地拉取分支进行开发
• 开发文章文件格式： Markdown 语法格式 (opens new window)
• 专栏笔记目录结构

目录	说明
./$MODULE	专栏名称
./$MODULE/_images	开发期间专栏引用图片
./$MODULE/_notes	专栏内容笔记内容 (参考书籍、源图片等内容)
./$MODULE/_sidebar-plan.md	目录设计计划
./$MODULE/README.md	专栏介绍（默认为专栏导言）
./$MODULE/_sidebar.js	侧导航配置，配置后引入custom-sidebar.js即可展示

• 贡献者审核校验
• 专栏完成后提交 PR
• 贡献成员交叉校验审核后正式发布

文章内容编写建议

图片相关

• 作图采用 draw.io (opens new window) 、Keynote 工具，统一图片风格
• 作图原始文件保留，每个专栏尽量使用一个文件(专栏.drawio/专栏.key)，每个工作页(幻灯片)一个图。减少原始文件的维护复杂度。
• 作图是避免使用高亮颜色，尽量使用温和色系
• 图片命名不可包含空格，中英文之间用"-"连接
• 图片前缀地址 https://raw.githubusercontent.com/$YOU-GITHUB/review-notes-dev/$MODULE/_images/ ，提交 PR 后统一更换前缀地址为阿里云 OSS 图床服务前缀地址
• 图片不支持 SVG 格式，使用 在线图片转换工具 (opens new window) 将 SVG 转 PNG 等其他格式
• 图片展示居中格式引入代码示例如下（根据实际图片条件长宽）：

<div align="center">
    <img src="https://blog-review-notes.oss-cn-beijing.aliyuncs.com/.../_images/$NAME.png">
    <p>$NAME</p>
</div>

内容相关

• 文章内引用该笔记内部文章时不使用 URL ，仅使用静态文字参考某某专栏《文章标题》 ，防止更新导致链接丢失
• 文章内容以二级标题（## ）为目录大纲（一级标题与文件名一致，可忽略不写）
• 中文语句句号采用"。"，英文语句句号采用"."

排版相关

• 尽量使用列表符号，清晰表达逻辑层次
• 添加空行可使用  （空格字符）
• 内容排版参考 排版指南 (opens new window)
• 推荐使用 中英文排版工具 (opens new window) 进行排版优化
• 推荐参考 学习方法.md 中推荐费曼学习法进行知识整理