forked from opentiny/tiny-vue
docs: add commit message guideline (#715)
This commit is contained in:
yoyo
GitHub
parent
fc6c6cb2c0
commit
69996986bf
|
|
@ -38,6 +38,25 @@ The following information is required for the Issue of the new feature:
|
|||
|
||||
Before submitting pull request, please make sure that your submission is in line with the overall plan of TinyVue. Generally, issues that marked as [bug](https://github.com/opentiny/tiny-vue/labels/bug) are encouraged to submit pull requests. If you are not sure, you can create a [Discussion](https://github.com/opentiny/tiny-vue/discussions) for discussion.
|
||||
|
||||
### Pull Request specification
|
||||
|
||||
- The commit message should be in the form of a `type(scope): description of the message`, e.g. `fix(vue-renderless): [scrollbar, action-menu] fix xxx bug`.
|
||||
|
||||
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.
|
||||
|
||||
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`
|
||||
|
||||
Local startup steps:
|
||||
|
||||
- Click the Fork button in the upper right corner of the [TinyVue](https://github.com/opentiny/tiny-vue) code repository to Fork the upstream repository to the personal repository.
|
||||
|
|
@ -85,7 +104,7 @@ The contribution process is over, thank you for your contribution!
|
|||
If you are interested in our open source project, you are welcome to join our open source community in the following ways.
|
||||
|
||||
- Add official assistant WeChat: opentiny-official to join our technical exchange group.
|
||||
- Add to the mailing list: opentiny@googlegroups.com
|
||||
- Add to the mailing list: <opentiny@googlegroups.com>
|
||||
|
||||
If you have submitted Issue or PR to OpenTiny, you can comment on Issue or Pull Request, asking @all-contributors to add a contributor:
|
||||
|
||||
|
|
|
|||
|
|
@ -38,6 +38,25 @@
|
|||
|
||||
提交 PR 之前，请先确保你提交的内容是符合 TinyVue 整体规划的，一般已经标记为 [bug](https://github.com/opentiny/tiny-vue/labels/bug) 的 Issue 是鼓励提交 PR 的，如果你不是很确定，可以创建一个 [Discussion](https://github.com/opentiny/tiny-vue/discussions) 进行讨论。
|
||||
|
||||
### Pull Request 规范
|
||||
|
||||
- commit 信息要以 `type(scope): 描述信息` 的形式填写，例如 `fix(vue-renderless): [scrollbar, action-menu] fix xxx bug`。
|
||||
|
||||
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的测试用例，当改动的代码会影响组件时，需要声明这个结构。
|
||||
|
||||
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`
|
||||
|
||||
本地启动步骤：
|
||||
|
||||
- 点击 [TinyVue](https://github.com/opentiny/tiny-vue) 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库
|
||||
|
|
@ -85,7 +104,7 @@ pnpm dev:vue2
|
|||
如果你对我们的开源项目感兴趣，欢迎通过以下方式加入我们的开源社区。
|
||||
|
||||
- 添加官方小助手微信：opentiny-official，加入我们的技术交流群
|
||||
- 加入邮件列表：opentiny@googlegroups.com
|
||||
- 加入邮件列表：<opentiny@googlegroups.com>
|
||||
|
||||
如果你给 OpenTiny 提交过 Issue 或 PR，请通过以下方式添加自己到贡献者列表里。
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue