diff --git a/docs/source/commit_msg/index.rst b/docs/source/commit_msg/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..bf2e4fdca80de00d4566d8692624fb879e93fb66 --- /dev/null +++ b/docs/source/commit_msg/index.rst @@ -0,0 +1,32 @@ +.. _commit_msg: + +commit提交规范 +###################################### + +开发人员提交带有修复程序的gitee pr,其commit msg需遵循相同的准则,该检查是基于gitlint工具来检查 + +- **commit msg规范** + +commit msg提交规范由三部分组成:title, body, foot + +title简明说明该次pr提交信息,(:)号前面是模块儿名,后面是简要信息 + +body详细说明该次提交的信息 + +foot由固定格式组成,第一部分是Signed-off-by,空格后是开发者用户名,再空格后是开发者邮箱 + + script: this is title + + this is body + + Signed-off-by: xxx xxx@yy.com + +- **范例** + +以下是一个提交范例 + + yocto: support compile xxx + + support compile xxx, this module is new and deal some archs now not supporting + + Signed-off-by: xxx xxx@xxx.com \ No newline at end of file diff --git a/docs/source/contribute_doc.rst b/docs/source/contribute_doc.rst index d8fc2681c4b99df5d3f2bd34e1e856cf5db8130f..042afdeba6a87607c21efb86d137c75ded51f825 100644 --- a/docs/source/contribute_doc.rst +++ b/docs/source/contribute_doc.rst @@ -1,5 +1,6 @@ .. _contribute_doc: + 如何撰写并贡献文档 ################## diff --git a/docs/source/index.rst b/docs/source/index.rst index 4b5e083301d2ce4ba52d7a687d1d8ae72a1dd650..1424c6ff55353c88284f2a015565c5752f15ac17 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,6 +23,7 @@ openEuler Embedded在内核版本、软件包版本等代码层面会与openEule features/index.rst yocto/index.rst qemu/index.rst + commit_msg/index.rst contribute_doc.rst security_hardening/index.rst releases/index.rst diff --git a/docs/source/introduction/index.rst b/docs/source/introduction/index.rst index 0124cfe6d6ef9ab47f822f32cd8f75fc5ce6ca29..4840ad12e676f29b9a434909fb811c17dfdd258d 100644 --- a/docs/source/introduction/index.rst +++ b/docs/source/introduction/index.rst @@ -1,4 +1,4 @@ -.. _introducing_openeuler_embedded: +.. _introducing: 总体介绍 diff --git a/docs/source/security_hardening/index.rst b/docs/source/security_hardening/index.rst index 93783341ca12dfbcff5358eab4c26c87346422a6..3f641d95844ec0a4c872c97508172e227fca2ac7 100644 --- a/docs/source/security_hardening/index.rst +++ b/docs/source/security_hardening/index.rst @@ -1,6 +1,5 @@ .. _security_hardening: - 安全加固说明 ################################