Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 1.36 KB

File metadata and controls

17 lines (11 loc) · 1.36 KB

贡献指南

首先,欢迎你为本项目作出贡献!作为个人笔记项目,项目内容主要是仓库所有人的学习过程思考与记录,会充满大量个人风格的描述与代码。一个人的力量总是有限的,希望能有更多人贡献自己的知识与理解,让这个项目变得更加完善。

贡献须知

由于本项目是「个人笔记」性质,内容描述、代码风格等都带有强烈的个人风格。为了维护此性质,仓库所有人会依据「个人喜好」,对贡献内容进行有选择的增加、修改。

同时由于精力有限,审核合并的效率受限,还望包涵。

贡献流程

  1. 首先,你需要 fetch 一份仓库到自己的仓库中
  2. 新建一个分支进行修改。分支命名请尽量遵循 type/category-topic 的格式命名,如 feat/graph-floyd。同时 commit 信息格式请遵序 <type>(<filename>): <abstract> 的格式,同时 abstract 部分尽量简洁清晰,50 字以内。
  3. 向本仓库提交 pr。pr 名称应清晰简洁描述修改内容,同时在描述中附带更多细节(如果有的话)
  4. pr 提交后会触发 CI,在 netlify 部署一份预览。请查看预览,是否符合预期效果。只有在 netlify 预览成功部署时 pr 才有可能被合并,否则会影响主站点的构建。
  5. 等待 review 通过或进一步修改。