How To Contribute
主要流程
- 将本仓库 Fork 一份到你自己的 Github 账户上
- 在 Fork 的仓库内做出更改并提交
- 点击仓库的 Contribute 按钮
- 正确书写 Pull Request 内容,点击 Open
- 管理员在审核通过后会进行合并
PR 书写规范
- 简练列出对项目的更改
- 在需要时引用对应的 Issue
- 尽量使用 Markdown 格式书写
Commit规范
- 一个 commit 对应一个最小功能的改进。例如,对项目的代码格式进行更新时,应该对链接、图片、Markdown 分别提交 commit
- 每个 commit 要写清楚修改了哪些东西
- 尽量使用 Markdown 格式书写
代码规范
- 文章内引用其他 md 文件的链接应使用相对链接
- 插入图片时,必须将图片保存在
./img/[md file]/目录中,引用时使用相对路径引用 - 尽量减少 HTML 代码的使用
注:此页面内容与仓库根目录
CONTRIBUTING.md保持一致,若有更新请以仓库版本为准。