维护者手册.md - - 山东大学 - 课程资料共享计划

文件名称:

维护者手册.md

所在目录:

文件大小:

854.00 B

下载地址:

文本预览:

# 维护者手册.md
请按照此手册规范进行维护，虽然稍微麻烦些，但习惯之后会
- 保持较高的仓库质量
- 减少后续学弟学妹们的维护成本
## commit 规范
commit 名称统一为： `git commit -m "<科目名称>: <修改的内容>"`，注意为英文冒号
如果修改的为根目录的文档，则格式为： `git commit -m "doc(): <修改的内容>"`，注意为英文冒号，如果修改为多个文件，则可直接 `doc: <修改的内容>`
## Merge 规范
sqush 贡献者的 Merge，在详细内容里写清楚改变的内容，commit 也按照上面的 commit 规范
## 文档规范
请下载 vscode 插件 Markdown lint 插件，严格遵守与维护书写格式
## tips
在线版的 vscode 十分好用，还不用下载大多数的文件，进入方式为按键盘上的 `> .` 键