forked from opentiny/tiny-vue
docs: update CONTRIBUTING.md (#62)
This commit is contained in:
GitHub
parent
22e384896f
commit
f276a7c7aa
|
|
@ -40,6 +40,7 @@
|
|||
|
||||
- 点击 [TinyVue](https://github.com/opentiny/tiny-vue) 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库
|
||||
- Clone 个人仓库到本地
|
||||
- 关联上游仓库，方便同步上游仓库最新代码
|
||||
- 在 Tiny Vue 根目录下运行 npm i, 安装 node 依赖
|
||||
- 运行 npm run dev:vue3，启动组件库网站
|
||||
- 打开浏览器访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
|
|
@ -48,7 +49,11 @@
|
|||
# username 为用户名，执行前请替换
|
||||
git clone git@github.com:username/tiny-vue.git
|
||||
cd tiny-vue
|
||||
|
||||
# 关联上游仓库
|
||||
git remote add upstream git@github.com:opentiny/tiny-vue.git
|
||||
|
||||
# 安装依赖
|
||||
npm i
|
||||
|
||||
# 启动 Vue3 项目
|
||||
|
|
@ -61,11 +66,11 @@ npm run dev:vue2
|
|||
提交 PR 的步骤：
|
||||
|
||||
- 请确保你已经完成本地启动中的步骤，并能正常访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
- 创建新分支 `git checkout -b username/feature1`，分支名字建议为 `username/feat-xxx` / `username/fix-xxx`
|
||||
- 同步上游仓库 dev 分支最新代码：git pull upstream dev
|
||||
- 从上游仓库 dev 分支创建新分支 `git checkout -b username/feature1 upstream/dev`，分支名字建议为 `username/feat-xxx` / `username/fix-xxx`
|
||||
- 本地编码
|
||||
- 遵循 [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范进行提交，不符合提交规范的 PR 将不会被合并
|
||||
- 提交到远程仓库：git push origin branchName
|
||||
- (可选)同步上游仓库 dev 分支最新代码：git pull upstream dev
|
||||
- 打开 TinyVue 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-vue/pulls) 链接，点击 New pull request 按钮提交 PR
|
||||
- 项目 Committer 进行 Code Review，并提出意见
|
||||
- PR 作者根据意见调整代码，请注意一个分支发起了 PR 后，后续的 commit 会自动同步，无需重新提交 PR
|
||||
|
|
|
|||
Loading…
Reference in New Issue