add write-commit-message and style create-issue

ying.liu · ying.liu · commit 3908c666c625 · 2018-12-12T08:58:19.000-08:00
diff --git a/dev-process/create-issue.md b/dev-process/create-issue.md
@@ -0,0 +1,30 @@
+# Create Issue
+
+这是关于 Issue 的管理和描述的建议。
+
+## Issue 管理
+
+1. 测哪部份，给那部分开 issue，认领，分析完，再分发出去。例如测试前端，就给前端提 issue，前端分析是后台的，就给后台再开 issue
+2. 谁开的 issue、谁来验证、关闭，其他人不要关
+3. issue：包含 future 和 bug 两种类型
+4. 日清（每天下班时，保证当前之前的 issue 都已经认领完了，当天验证的 issue 都已经关闭了）+项目的每个成员都要参与（和看板一样，每日关注）
+
+## isuue 编写的格式
+
+每个 Issue 有一个简单概要的标题。描述部分尽量包含下面几个内容
+
+### Issue 描述
+
+- 出现设备
+- 出现版本
+- 出现浏览器（如果是 web 的话）
+- 出现的系统版本
+- 描述 Issue 能够影响到的范围
+- 出现的场景，以及现象的描述
+
+### Issue 复现方式
+
+- 具体软件硬件条件
+- 具体操作方式
+
+### Issue 相关图片（如果有）
diff --git a/dev-process/how-to-write-issue.md b/dev-process/how-to-write-issue.md
diff --git a/dev-process/write-commit-message.md b/dev-process/write-commit-message.md
@@ -0,0 +1,57 @@
+# Write Good Commit Message
+
+写出好的提交信息有助于提高代码可维护性。提交信息包含三个部分：标题(Subject)，主体(Body)和相关 Issue。各个部分之间用空行隔开。参考了[write good git commit meesage](https://juffalow.com/other/write-good-git-commit-message).
+
+## 提交信息建议
+
+### 标题
+
+好的标题应该回答这个问题： 如果生效，这个提交（commit）""
+在空的地方应该填入动词加名词的一个简单句子。不超过 50 个字母。
+
+好的例子：
+
+- 如果生效，这个提交（commit）“删除多余的文件”
+- 如果生效，这个提交（commit）“可以选择多个用户地址”
+- 如果生效，这个提交（commit）"fix bug when network is disconnected"
+
+不好的例子
+
+- 如果生效，这个提交（commit）“fix bug"
+- 如果生效，这个提交（commit）"user group"
+
+建议标题的尽可能用英文，可以参考如下类别：
+
+- Add = Create a capability e.g. feature, test, dependency.
+- Cut = Remove a capability e.g. feature, test, dependency.
+- Fix = Fix an issue e.g. bug, typo, accident, misstatement.
+- Bump = Increase the version of something e.g. dependency.
+- Make = Change the build process, or tooling, or infra.
+- Start = Begin doing something; e.g. create a feature flag.
+- Stop = End doing something; e.g. remove a feature flag.
+- Refactor = A code change that MUST be just a refactoring.
+- Reformat = Refactor of formatting, e.g. omit whitespace.
+- Optimize = Refactor of performance, e.g. speed up code.
+- Document = Refactor of documentation, e.g. help files.
+
+### 主体
+
+描述为什么做这个提交以及代码完成了哪些具体功能和做了哪些改动。主体包含多行, 行长度不要超过 72 个字符。
+
+### Issue
+
+列出相关的 Issue Number。
+
+## 例子
+
+```txt
+Fix error when protocol is missing
+
+First, it checks if the protocol is set. If not, it changes the url and
+add the basic http protocol on the beginning.
+Second, it does a "preflight" request and follows all redirects and
+returns the last URL. The process then continues with this URL.
+
+Resolves: #56, #78
+See also: #12, #34
+```
