Skip to content
江不知 edited this page Sep 1, 2019 · 3 revisions

项目规范

Markdown 书写规范

遵循 中文文案排版指北

Commit Message 规范

Commit Message 格式为:

emoji(scope): message

emoji

特定 emoji 表情指代不同提交类型:

  • 新增内容:
    • 🐱来自 Jalan 的贡献
    • 🎃来自 Csming 的贡献
  • ❤️ 文档修改(主要是 README 文档)
  • 💪结构/配置修改
  • 🧙‍♂️错误纠正

scope

提交内容涉及范围,全局使用 * 标记,其他则使用具体题解分类的英文。例如贡献数组题解 scope 为 array,贡献字符串题解 scope 为 string

message

提交信息的具体内容,如提交某题解直接标注题号即可。也可自由发挥,清晰明了就行~

项目更新

更新时直接推送到 master 分支即可,git page 将根据分支下的 ./docs 文件夹内容进行显示。

./docs 内部 README.md 文件已与根目录 README.md 文件建立软链,修改 README.md 文档时直接修改 ./docs 下的 README.md 即可。

Clone this wiki locally