- Compass-ci - mailweb.openeuler.org

[PATCH compass-ci] code-spec: refactor friendly principles
by Wu Fengguang 28 Sep '20

28 Sep '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- doc/code-spec.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/code-spec.md b/doc/code-spec.md index e783a0c..f805aec 100644 --- a/doc/code-spec.md +++ b/doc/code-spec.md @@ -7,6 +7,23 @@ code注意事项 - 一个函数, 不要超过10行代码 - 起准确和有意义的变量/函数名字, 名字要让人看出赋予他们的确切意义 +重构友好编码 +============ + +基本原则: +- 预防自己的代码造成他人的几大困难 + - 难以理解不敢下手 + - 不知道怎么找到*所有*关联逻辑 + - 不知道自己不知道 (unknown unknown) +- 设想将来做重构, 或者需要理解任何一个高层次的功能/流程, + 一个新人应当可以通过 git grep 一两个关键字或者pattern, + 就能找到所有相关底层代码与文档, 而不必担心有所遗漏. + +基本方法: +- 隐式场景显式化: 加注释明确代码的各类隐含目的, 意义, 场景, 数据示例等等 +- 隐式依赖显式化: 定义相同的ID, 把所有的关联文档与各处代码串起来 +- 分散依赖集中化: 定义类/函数/assert, 封装/强制各类设计中的假设, 约定与规则 + PATCH注意事项 ============= -- 2.23.0

1 0

[PATCH lkp-tests] Makefile: support ctags
by Wu Fengguang 28 Sep '20

28 Sep '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- Makefile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Makefile b/Makefile index c40d914b..37387809 100644 --- a/Makefile +++ b/Makefile @@ -23,3 +23,6 @@ doc: tests/%.md: tests/%.yaml lkp gen-doc $< + +ctags: + ctags -R --links=no -- 2.23.0

1 0

[PATCH compass-ci] doc: add code-spec.md
by Wu Fengguang 27 Sep '20

27 Sep '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- doc/code-spec.md | 42 ++++++++++++++++++++++++++++++++++++++ doc/develop-environment.md | 1 + 2 files changed, 43 insertions(+) create mode 100644 doc/code-spec.md diff --git a/doc/code-spec.md b/doc/code-spec.md new file mode 100644 index 0000000..e783a0c --- /dev/null +++ b/doc/code-spec.md @@ -0,0 +1,42 @@ +code注意事项 +============ + +- 代码应当放进函数里不要在脚本顶层直接写逻辑 +- 代码应当放进lib/里脚本本身最小化, 仅解析命令行参数, 调用lib/入口函数 +- 如果出现了全局变量一般意味着需要写一个 class/module 来放这个状态量了 +- 一个函数, 不要超过10行代码 +- 起准确和有意义的变量/函数名字, 名字要让人看出赋予他们的确切意义 + +PATCH注意事项 +============= + +- PATCH title 应当简要说明做了什么 (what) +- PATCH changelog / code comment 应当解释读者无法从代码简单推断的 + - 背景 + - 目的 + - 效果 + - 设计选项和权衡 + - 实际例子 + - 改进数字 + - bug场景, 出错消息原文 +- PATCH 应当加上作者签名 (Signed-off-by: Name <email>) +- PATCH 最好不超过100行, 一个PATCH只做一件事, 避免混杂多个逻辑变更 + +PATCH参考材料 +============= + +The patch subject and changelog should be well written according to suggestions +here: + + https://github.com/thoughtbot/dotfiles/blob/master/gitmessage + https://www.cnblogs.com/cpselvis/p/6423874.html + + http://www.ozlabs.org/~akpm/stuff/tpp.txt + 2: Subject: + 3: Attribution + 4: Changelog + + https://www.kernel.org/doc/html/latest/translations/zh_CN/process/submittin… + 2) 描述你的改动 + 3) 拆分你的改动 + 8）回复评审意见 diff --git a/doc/develop-environment.md b/doc/develop-environment.md index 3af44ac..8760878 100644 --- a/doc/develop-environment.md +++ b/doc/develop-environment.md @@ -50,6 +50,7 @@ Then read through documents lkp-tests/doc/INSTALL.md compass-ci/doc/INSTALL.md + compass-ci/doc/code-spec.md compass-ci/doc/learning-resources.md # crystal compiler -- 2.23.0

1 0

[PATCH todo] credit: fix typos
by Wu Fengguang 26 Sep '20

26 Sep '20

Signed-off-by: Wu Fengguang <wfg(a)mail.ustc.edu.cn> --- people/LiangTao/credit/2020-09-11.md | 2 +- people/LiuShaofei/credit/2020-08-14.md | 2 +- people/LiuYinsi/credit/2020-09-25.md | 1 - people/LuWeitao/credit/2020-09-18.md | 2 +- people/LuWeitao/credit/2020-09-25.md | 2 +- people/LuanShengde/credit/2020-09-18.md | 1 - people/WangChenglong/credit/2020-09-25.md | 1 - people/XuXijian/credit/2020-07-31.md | 2 +- people/XuXijian/credit/2020-08-07.md | 2 +- people/XuXijian/credit/2020-08-14.md | 2 +- 10 files changed, 7 insertions(+), 10 deletions(-) diff --git a/people/LiangTao/credit/2020-09-11.md b/people/LiangTao/credit/2020-09-11.md index 87afa33..464173b 100644 --- a/people/LiangTao/credit/2020-09-11.md +++ b/people/LiangTao/credit/2020-09-11.md @@ -1,4 +1,4 @@ Shi Zhichao Xiao Shenwei Wang Chenglong -Wei Jihiu +Wei Jihui diff --git a/people/LiuShaofei/credit/2020-08-14.md b/people/LiuShaofei/credit/2020-08-14.md index 66d1d24..a5a3f35 100644 --- a/people/LiuShaofei/credit/2020-08-14.md +++ b/people/LiuShaofei/credit/2020-08-14.md @@ -4,4 +4,4 @@ Wang Yong Bai Jing Yu Chuan Lin Jiaxin -Sun yukui +Sun Yukui diff --git a/people/LiuYinsi/credit/2020-09-25.md b/people/LiuYinsi/credit/2020-09-25.md index c7fb87e..f7652f6 100644 --- a/people/LiuYinsi/credit/2020-09-25.md +++ b/people/LiuYinsi/credit/2020-09-25.md @@ -3,4 +3,3 @@ Yu Chuan Luan Shengde Zhang Dewan Shi Zhichao - diff --git a/people/LuWeitao/credit/2020-09-18.md b/people/LuWeitao/credit/2020-09-18.md index 5f9f6ef..5678b6d 100644 --- a/people/LuWeitao/credit/2020-09-18.md +++ b/people/LuWeitao/credit/2020-09-18.md @@ -1,4 +1,4 @@ -Luan Shengden +Luan Shengde Wu Fengguang Zhang Yuhang Cao Xueliang diff --git a/people/LuWeitao/credit/2020-09-25.md b/people/LuWeitao/credit/2020-09-25.md index decb297..1f2515d 100644 --- a/people/LuWeitao/credit/2020-09-25.md +++ b/people/LuWeitao/credit/2020-09-25.md @@ -2,7 +2,7 @@ Wu Fengguang Du Kaitian Cao Xueliang Zhang Yuhang -Luan Shengden +Luan Shengde Sun Yukui Liu Shaofei Li Yuanchao diff --git a/people/LuanShengde/credit/2020-09-18.md b/people/LuanShengde/credit/2020-09-18.md index 574c682..4a81084 100644 --- a/people/LuanShengde/credit/2020-09-18.md +++ b/people/LuanShengde/credit/2020-09-18.md @@ -3,4 +3,3 @@ Lu Weitao Shi Zhichao Tong Qunfeng Zhang Dewan - diff --git a/people/WangChenglong/credit/2020-09-25.md b/people/WangChenglong/credit/2020-09-25.md index a0e4736..5239ca1 100644 --- a/people/WangChenglong/credit/2020-09-25.md +++ b/people/WangChenglong/credit/2020-09-25.md @@ -3,4 +3,3 @@ Shi Zhichao Wu Zhende Wang Yong Wei Jihui - diff --git a/people/XuXijian/credit/2020-07-31.md b/people/XuXijian/credit/2020-07-31.md index 5cf1aa4..36fea5e 100644 --- a/people/XuXijian/credit/2020-07-31.md +++ b/people/XuXijian/credit/2020-07-31.md @@ -1,4 +1,4 @@ -Zhang Dewang +Zhang Dewan Zhang Yale Yu Chuan Wang Yong diff --git a/people/XuXijian/credit/2020-08-07.md b/people/XuXijian/credit/2020-08-07.md index 056782a..cca2b2f 100644 --- a/people/XuXijian/credit/2020-08-07.md +++ b/people/XuXijian/credit/2020-08-07.md @@ -4,4 +4,4 @@ Li Yuanchao Xiao Shenwei Wei Jihui Yu Chuan -Zhang Dewang +Zhang Dewan diff --git a/people/XuXijian/credit/2020-08-14.md b/people/XuXijian/credit/2020-08-14.md index 7c60171..e9cfd69 100644 --- a/people/XuXijian/credit/2020-08-14.md +++ b/people/XuXijian/credit/2020-08-14.md @@ -1,4 +1,4 @@ -Shi zhichao +Shi Zhichao Luan Shengde Wang Yong Wu Fengguang -- 2.23.0

1 0

答复: Welcome to the "Compass-ci" mailing list
by Dukaitian (Dukaitian, Intelligent Computing R&D) 23 Sep '20

23 Sep '20

各位老师、开发者好：由于crystal 被其它公司注册了，及后缀CI的通用性，影响到crystal-ci 的名字，因此需要将项目名称 crystal-ci 修改为 compass-ci 后续我们需要通过compass-ci(a)openeuler.org 邮件列表来继续交流，crystal-ci(a)openEuler.org 预计在一个月后进行停用。由于变更给大家带来的麻烦深表歉意，敬请谅解，感谢大家一如既往的关注及支持。祝好 Jimmy_hero -----邮件原件----- 发件人: compass-ci-request(a)openeuler.org [mailto:compass-ci-request@openeuler.org] 发送时间: 2020年9月23日 17:25 收件人: Dukaitian (Dukaitian, Intelligent Computing R&D) <dukaitian(a)huawei.com> 主题: Welcome to the "Compass-ci" mailing list Welcome to the "Compass-ci" mailing list! To post to this list, send your email to: compass-ci(a)openeuler.org You can unsubscribe or make adjustments to your options via email by sending a message to: compass-ci-request(a)openeuler.org with the word 'help' in the subject or body (don't include the quotes), and you will get back a message with instructions. You will need your password to change your options, but for security purposes, this password is not included here. If you have forgotten your password you will need to reset it via the web UI.

1 0