diff --git "a/LLVM Parallel Universe Project/\345\217\202\344\270\216\350\264\241\347\214\256\346\214\207\345\257\274.md" "b/LLVM Parallel Universe Project/\345\217\202\344\270\216\350\264\241\347\214\256\346\214\207\345\257\274.md" index 2bbd016bccff12341bf803dcfe34adc74424f749..39b14d30d83885cff3a070d56b342e133a13a585 100644 --- "a/LLVM Parallel Universe Project/\345\217\202\344\270\216\350\264\241\347\214\256\346\214\207\345\257\274.md" +++ "b/LLVM Parallel Universe Project/\345\217\202\344\270\216\350\264\241\347\214\256\346\214\207\345\257\274.md" @@ -21,10 +21,39 @@ flowchart TD ### 2、PR提交规范 首先,在openEuler社区请遵守[社区PR提交指南](https://gitee.com/openeuler/community/blob/master/zh/contributors/pull-request.md),在软件包上游社区请遵守相应上游社区的PR提交规范。 此外,由于LLVM平行宇宙相关的PR通常涉及编译构建问题,故增加如下规则: -#### 2.1 PR描述 -* 描述尽量清晰,包含为什么需要合入这个PR及希望检视人员额外了解的信息。 + +#### 2.1 patch制作 +* 请基于`git format-patch`方法制作统一格式的patch,便于检视。 +以修改`source/test.c`为例,介绍一下制作方法: + +第一步:在`source`目录下初始化git。 +```abap +git init +``` +第二步:本地提交test.c文件基线。 +```abap +git add source/test.c +git commit -m "init" +``` +第三步:修改`test.c`文件。 +第四步:提交修改 +```abap +git add source/test.c +git commit -m "modify" +``` +第五步:生成patch。 +```abap +git format-patch HEAD^ // 基于最近一个commit做patch +git format-patch HEAD^^ // 基于最近两个commit做patch +``` + +#### 2.2 PR描述 +* 描述尽量清晰,包含为什么需要合入这个PR及希望检视人员额外了解的信息。至少包含两部分: + * 提交PR的背景。可以写基于[这个oEEP](https://gitee.com/openeuler/TC/blob/master/oEEP/oEEP-0003%20LLVM%E5%B9%B3%E8%A1%8C%E5%AE%87%E5%AE%99%E8%AE%A1%E5%88%92--%E5%9F%BA%E4%BA%8ELLVM%E6%8A%80%E6%9C%AF%E6%A0%88%E6%9E%84%E5%BB%BAoE%E8%BD%AF%E4%BB%B6%E5%8C%85.md),该PR的主要目标是使得当前软件包同时支持LLVM构建 + * 不影响当前的构建行为,并贴上自验证链接。 * 如果该PR是从上游社区backport回来的,**请在PR描述上写明上游社区的issue链接(如果有的话)和PR链接。** -#### 2.2 代码检视 + +#### 2.3 代码检视 * 首先,提交PR时,首先在PR题目上加上`[WIP]`,即告知maintainer/committer当前PR尚处于草稿状态。 * 然后,在LLVM平行宇宙微信群请求review; * 如果已获得两个或两个以上[LLVM平行宇宙项目commiters](https://gitee.com/cf-zhao/compiler-docs/blob/master/LLVM%20Parallel%20Universe%20Project/%E5%8F%82%E4%B8%8E%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%AF%BC.md#4llvm%E5%B9%B3%E8%A1%8C%E5%AE%87%E5%AE%99%E9%A1%B9%E7%9B%AEcommiters%E6%8C%81%E7%BB%AD%E5%A2%9E%E5%8A%A0%E4%B8%AD)的`lgtm`,则可以将PR题目中的`[WIP]`删去。