Skip to content

Commit f4e69df

Browse files
author
hubert
committed
chore: readme change
1 parent d28f6af commit f4e69df

File tree

2 files changed

+48
-45
lines changed

2 files changed

+48
-45
lines changed

DEVELOP.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## 开发注意事项
2+
3+
### changelog
4+
5+
`lerna-changelog`基于`pr`来为项目生成`changelog`
6+
7+
<strong>使用步骤</strong>
8+
9+
1、从`master`分支切换出`feature`/`bugfix`等分支。
10+
2、完成开发后进行`commit`,推荐使用`commitizen`来规范`commit msg`,同时有助于对后续子项目生成`changelog`
11+
3、将新分支`push``remote`端。
12+
4、创建`pr`,并打上`label`,此处一定要打上`label``learn-changelog`就是根据 label 来确定该`pr`属于`feature`/`bugfix`/`document`等。
13+
5、切记要在`merge`之前打上`label`
14+
6、进行`merge` `pr`操作。
15+
7、本地切换到`master`分支并进行`pull操`作。
16+
8、执行`lerna-changelog`,既可得到一份`changeling`
17+
18+
<strong>注意</strong>
19+
20+
1、`pr``label`并不能随意设置,一定要在项目中声明对应才生效。
21+
官方默认支持`breaking`/`enhancement`/`bug`/`documentation`/`internal`,如果想用其他,则需要在 package.json 中进行相应的配置。
22+
23+
```json
24+
{
25+
"changelog": {
26+
"labels": {
27+
"feat": ":rocket: New Feature",
28+
"bug": ":bug: Bug Fix",
29+
"doc": ":memo: Documentation",
30+
"internal": ":house: Internal",
31+
"breaking": ":boom: Breaking Change"
32+
}
33+
}
34+
}
35+
```
36+
37+
2、src/version 在 publish 时自动更新版本号,不需要手动修改。发布后不需要签入。
38+
39+
<br>
40+
41+
### 子项目的 changelog
42+
43+
具体还需参考[README](https://github.com/lerna/lerna/blob/514bc57a53/commands/version/README.md#--conventional-commits)

README.md

Lines changed: 5 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,10 @@
1-
# Vue 模块化加载 Monorepo
2-
> Vue 模块通过打包成 lib 的umd 脚本文件独立布置在任何远端服务器上,
3-
> 主程序能过调用远程 umd 脚本文件动态渲染到前端页面
1+
# Vue2 Projects
2+
[![Deploy](https://github.com/aceHubert/vue-async/actions/workflows/deploy.yml/badge.svg)](https://github.com/aceHubert/vue-async/actions/workflows/deploy.yml)
43

5-
<br>
6-
<br>
4+
- [Vue2模块化加载](./packages/module-loader/README.md)
5+
- [React Suspense in Vue2](./packages/resource-manager/README.md)
6+
- [开发注意事项](./DEVELOP.md)
77

8-
[模块化加载说明文档](./packages/module-loader/README.md)
9-
[React Suspense in Vue](./packages/resource-manager/README.md)
10-
[公共方法Utils](./packages/utils/README.md)
118

129
<br>
1310
<br>
14-
15-
## Lerna-changelog
16-
`lerna-changelog`基于`pr`来为项目生成`changelog`
17-
18-
<strong>使用步骤</strong>
19-
20-
1、从`master`分支切换出`feature`/`bugfix`等分支。
21-
2、完成开发后进行`commit`,推荐使用`commitizen`来规范`commit msg`,同时有助于对后续子项目生成`changelog`
22-
3、将新分支`push``remote`端。
23-
4、创建`pr`,并打上`label`,此处一定要打上`label``learn-changelog`就是根据label来确定该`pr`属于`feature`/`bugfix`/`document`等。
24-
5、切记要在`merge`之前打上`label`
25-
6、进行`merge` `pr`操作。
26-
7、本地切换到`master`分支并进行`pull操`作。
27-
8、执行`lerna-changelog`,既可得到一份`changeling`
28-
29-
<strong>注意</strong>
30-
31-
`pr``label`并不能随意设置,一定要在项目中声明对应才生效。
32-
官方默认支持`breaking`/`enhancement`/`bug`/`documentation`/`internal`,如果想用其他,则需要在package.json中进行相应的配置。
33-
``` json
34-
{
35-
"changelog": {
36-
"labels": {
37-
"feat": ":rocket: New Feature",
38-
"bug": ":bug: Bug Fix",
39-
"doc": ":memo: Documentation",
40-
"internal": ":house: Internal",
41-
"breaking": ":boom: Breaking Change"
42-
}
43-
}
44-
}
45-
```
46-
47-
<br>
48-
49-
## 子项目的changelog
50-
具体还需参考[README](https://github.com/lerna/lerna/blob/514bc57a53/commands/version/README.md#--conventional-commits)

0 commit comments

Comments
 (0)