OSDN Git Service

feat(htc): add requirement for pr and commit
authorShuhao Zhang <studyingfather@gmail.com>
Sat, 17 Oct 2020 13:43:46 +0000 (21:43 +0800)
committerGitHub <noreply@github.com>
Sat, 17 Oct 2020 13:43:46 +0000 (21:43 +0800)
docs/intro/htc.md

index 3416e38..3333272 100644 (file)
 3. 依据 [格式手册](format.md) 编写内容;
 4. 在决定将内容推送到本仓库时, **请首先拉取本仓库代码进行合并,自行处理好冲突,同时确保在本地可以正常生成文档** ,然后再将分支 PR 到主仓库的 master 分支上。
 
+### commit 与 Pull Request 要求
+
+对于提交时需要填写的 commit 信息,请遵守以下几点基本要求:
+
+1. commit 摘要请简要描述这一次 commit 改动的内容。注意 commit 摘要的长度不要超过 50 字符,超出的部分会自动置于正文中。
+2. 如果需要进一步描述本次 commit 内容,请在正文中详细说明。
+
+对于 commit 摘要,推荐按照如下格式书写:
+
+```plain
+<修改类型>(<文件名>): <修改的内容>
+```
+
+修改类型分为如下几类:
+
+- `feat`:用于添加内容的情况。
+- `fix`:用于修正现有内容错误的情况。
+- `refactor`:用于对一个页面进行重构(较大规模的更改)的情况。
+- `revert`:用于回退之前更改的情况。
+
+对于 Pull Request,请遵守以下几点要求:
+
+1. 标题请写明本次 PR 的目的(做了 **什么** 工作,修复了 **什么** 问题)。
+2. 内容请简要叙述修改的内容。如果修复了一个 issue 的问题,请在内容中添加 `fix #xxxx` 字段,其中 `xxxx` 代表 issue 的编号。
+3. 推荐删除 commit message 中的模板信息(“首先,十分感谢……”这一段)。
+
+下面是几个 PR 标题的示例:
+
+- (错误)修复了一个 bug
+- (正确)修复了动态 dp 页面的一个公式 typo
+- (错误)添加了新内容
+- (正确)为时间复杂度页面添加了证明
+
 ### 协作流程
 
 1. 在收到一个新的 Pull Request 之后,GitHub 会给 reviewer 发送邮件;