From 0b78f3a3e58aa19a06728592e80050d889600df5 Mon Sep 17 00:00:00 2001
From: yoyo <15014217605@163.com>
Date: Fri, 2 Feb 2024 11:01:03 +0800
Subject: [PATCH] docs: supplement the pr title description document (#1360)

---
 CONTRIBUTING.md       | 6 +++++-
 CONTRIBUTING.zh-CN.md | 6 +++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d288a3f6c..4efc4452e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -55,7 +55,11 @@ Before submitting pull request, please make sure that your submission is in line
 
   1. The specification of the title is the same as the commit information, which is entered in the form of `type(scope): description information`.
 
-  2. e2e test of trigger components: Adding `[componentName1, componentName2]` to the Pull Request title will execute test cases for componentName1, componentName2, and declare this structure when changes to code affect components.
+  2. **e2e test** of trigger components: Adding '[componentName1, componentName2]' to the Pull Request title will execute test cases for componentName1, componentName2, and declare this structure when changes to code affect components.
+
+     - Note: The `github action` in this project identifies test e2e use cases to be executed by matching the component names declared by `[componentName1, componentName2]` with the path names in the `examples/sites/demos` directory. (Because running the full test case is too time consuming)
+
+     - When modifying a sub-component of a component, such as the `col` component, which has no corresponding examples and test cases, the `layout` component should be tested, because the `col` component is a sub-component of the `layout` component. The PR title can be: `fix(col): [layout] xxxxxxxxxxxxxx`
 
   3. Example title:
 
diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md
index 9abf55096..f26de793a 100644
--- a/CONTRIBUTING.zh-CN.md
+++ b/CONTRIBUTING.zh-CN.md
@@ -55,7 +55,11 @@
 
   1. 标题的规范与 commit 信息一样，以`type(scope): 描述信息` 的形式填写。
 
-  2. 触发组件的 e2e 测试: 在 Pull Request 标题里添加 `[componentName1, componentName2]`，将会执行 componentName1，componentName2 的测试用例，当改动的代码会影响组件时，需要声明这个结构。
+  2. 触发组件的 **e2e 测试**: 在 Pull Request 标题里添加 `[componentName1, componentName2]`，将会执行 componentName1，componentName2 的测试用例，当改动的代码会影响组件时，需要声明这个结构。
+
+     - 注：本项目下的 `github action` 会用`[componentName1, componentName2]`声明的组件名匹配 `examples/sites/demos` 目录下的路径名称，识别要执行的测试e2e用例。（因为全量跑测试用例太耗费时间）
+
+     - 当修改了某个组件的子组件，比如`col`组件，它本身没有对应的示例以及测试用例，这时应该要测试的是`layout`组件，因为`col`组件是`layout`组件的子组件，PR 标题可以这样： `fix(col): [layout] xxxxxxxxxxxxxx`
 
   3. 标题示例: