diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cec96643f..d288a3f6c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,17 +45,23 @@ Before submitting pull request, please make sure that your submission is in line 1. type: must be one of build, chore, ci, docs, feat, fix, perf, refactor, revert, release, style, test, improvement. 2. scope. + - Package names in the `packages` directory, e.g. `vue-design-aurora, vue-design-saas, react ......` - Component name under the package name in the `packages` directory, e.g., `vue-design-aurora/alert, vue-design-saas/alert, react/alert ......` - The name of the folder to use: e.g.: `gulp, internals/playwright-config, sites` - The name of the component (lowercase, center dot): e.g.: `action-menu, alert ......` - 3. Run e2e tests: Using `[componentName1, componentName2]` in the commit message will execute the test case for componentName1, componentName2, which needs to be declared when changing code that affects the component. +- Pull Request title - 4. Example. - - Supplemental documentation for the alert component: `docs(alert): [alert] xxxxxxxxxxxxxxxxxxx`, `docs(site): [alert] xxxxxxxxxxxxxxx` - - Add test case for the alert component: `test(alert): [alert] xxxxxxxxxxxxxxxxxx`. - - Fix a bug in the alter component @opentiny/vue-renderless: `fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxxxx` + 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. + + 3. Example title: + + - Supplement alert component document: `docs(alert): [alert] xxxxxxxxxxxxxxx`, `docs(site): [alert] xxxxxxxxxxxxxxx` + - Supplement alet component test case: `test(alert): [alert] xxxxxxxxxxxxxx` + - Fixed bug in alet component @opentiny/vue-renderless: `fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxx` Local startup steps: diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index e4949383c..9abf55096 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -45,17 +45,23 @@ 1. type: 必须是 build, chore, ci, docs, feat, fix, perf, refactor, revert, release, style, test, improvement 其中的一个。 2. scope: + - `packages`目录下的包名,比如:`vue-design-aurora, vue-design-saas, react ......` - `packages`目录下的包名下的组件名,比如:`vue-design-aurora/alert, vue-design-saas/alert, react/alert ......` - 用文件夹的名称: 比如: `gulp, internals/playwright-config, sites` - 组件的名称(小写,中划线): 比如: `action-menu, alert ......` - 3. 运行e2e测试: 在提交信息里使用 `[componentName1, componentName2]`,将会执行componentName1,componentName2的测试用例,当改动的代码会影响组件时,需要声明这个结构。 +- Pull Request 的标题 - 4. 示例: - - 补充alert组件文档: `docs(alert): [alert] xxxxxxxxxxxxxxx`, `docs(site): [alert] xxxxxxxxxxxxxxx` - - 补充alet组件测试用例: `test(alert): [alert] xxxxxxxxxxxxxx` - - 修复alet组件@opentiny/vue-renderless下的缺陷: `fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxx` + 1. 标题的规范与 commit 信息一样,以`type(scope): 描述信息` 的形式填写。 + + 2. 触发组件的 e2e 测试: 在 Pull Request 标题里添加 `[componentName1, componentName2]`,将会执行 componentName1,componentName2 的测试用例,当改动的代码会影响组件时,需要声明这个结构。 + + 3. 标题示例: + + - 补充 alert 组件文档: `docs(alert): [alert] xxxxxxxxxxxxxxx`, `docs(site): [alert] xxxxxxxxxxxxxxx` + - 补充 alet 组件测试用例: `test(alert): [alert] xxxxxxxxxxxxxx` + - 修复 alet 组件 @opentiny/vue-renderless 下的缺陷: `fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxx` 本地启动步骤: