diff --git a/workflow.md b/workflow.md new file mode 100644 index 000000000..a357b3a81 --- /dev/null +++ b/workflow.md @@ -0,0 +1,54 @@ +# 工作流程 + +为了提高大家通过git协作的效率,特起草本流程。欢迎大家来改良本流程。 + +## 基本原则 + +所有成员都有读写本库的权限,大家通过分支来合作。 + +为了防止误操作删除Master分支,Master分支将被保护,只能通过PR修改Master分支。PR必须要至少一个其他成员的认可才能合并。 + +1. 每个md文件的翻译都创建一个新的分支,分支名字为改文章的标题 +2. 每个分支创建一个PR,PR标题与分支同名 +3. 大家通过分支来协作 +4. 最后定稿以后通过PR来合并到Master分支 + +最后,定期清理已经定稿的分支。 + +## 流程 + +### 创建分支并开始翻译 + +开始一章的翻译时,第一件要做的事就是在现在Master分支的基础上创建一个新分支,取名为该章节的名字。 + +开分支后,在本地checkout该新分支,用自己喜欢的编辑器在本地开始翻译工作。 + +### 通过分支创建PR + +在翻译工作进行到一个阶段以后,如果觉得可以拿出来给大家校对了,就在这个分支的基础上创建一个PR。 + +如果想要指定队友的帮助,请在Github PR界面中像该队友发出校对请求。也可以在微信里面请求。 + +发PR以后,可以接着随意在该分支上工作,在推送以后,PR将自动更新并列出相应的commit。 + +请注意,**发送PR以后,如果需要接着在该分支上工作,请先Pull,以防其它人有修改该分支,造成冲突。** + +非常重要:请注意查看其它队友的修改并积极交流,避免默认无条件接受他人修改。 + +### 通过分支校对其他战友的翻译 + +在本地checkout该分支,校对,commit,推送即可。PR会自动被更新。其它人可以随后Pull该分支的变化。 + +### 通过PR Review来交流意见 + +如果有需要大家注意的点,请考虑到PR上发留言。 + +### 定稿合并 + +在定稿后,需要至少一个其他队员到PR上发一条同意合并的意见,才能被合并到Master中。 + +合并后,该分支不再被使用。 + +### 定稿后微调 + +定稿后如果需要再次微调,重复上面的步骤,创建新分支。