docs: add contribution guide (#11510)
This commit is contained in:
@@ -66,7 +66,7 @@ root
|
||||
└─ .... # 其他周边 npm 包
|
||||
```
|
||||
|
||||
其中,`vant` 目录为组件库的核心代码:
|
||||
其中,`packages/vant` 目录为组件库的核心代码:
|
||||
|
||||
```
|
||||
vant
|
||||
@@ -76,7 +76,7 @@ vant
|
||||
└─ vant.config.mjs # 文档网站配置
|
||||
```
|
||||
|
||||
`src` 目录包含各个组件的源码,每个文件夹对应一个组件:
|
||||
`packages/vant/src` 目录包含各个组件的源码,每个文件夹对应一个组件:
|
||||
|
||||
```
|
||||
src
|
||||
@@ -86,7 +86,6 @@ src
|
||||
├─ Component.tsx # 组件
|
||||
├─ index.ts # 组件入口
|
||||
├─ index.less # 样式
|
||||
├─ var.less # 样式变量
|
||||
├─ README.md # 英文文档
|
||||
└─ README.zh-CN.md # 中文文档
|
||||
```
|
||||
@@ -97,22 +96,22 @@ src
|
||||
|
||||
- 确保代码可以通过仓库的 ESLint 校验。
|
||||
- 确保代码格式是规范的,使用 prettier 进行代码格式化。
|
||||
- 确保没有使用超出兼容性范围的 API,比如 `async/await`。
|
||||
- 确保没有使用超出兼容性范围的 API,比如 `async`, `await`.
|
||||
|
||||
## 提交 PR
|
||||
## 提交 Pull Request
|
||||
|
||||
### 参考指南
|
||||
|
||||
如果你是第一次在 GitHub 上提 Pull Request ,可以阅读下面这两篇文章来学习:
|
||||
|
||||
- [如何优雅地在 GitHub 上贡献代码](https://segmentfault.com/a/1190000000736629)
|
||||
- [第一次参与开源](https://github.com/firstcontributions/first-contributions/blob/main/translations/README.zh-cn.md)
|
||||
- [如何优雅地在 GitHub 上贡献代码](https://segmentfault.com/a/1190000000736629)
|
||||
|
||||
### Pull Request 规范
|
||||
|
||||
在提交 Pull Request 时,请注意:
|
||||
|
||||
- 如果遇到问题,建议保持你的 PR 足够小。保证一个 PR 只解决单个问题、添加单个功能。
|
||||
- 保持你的 PR 足够小,一个 PR 只解决单个问题或添加单个功能。
|
||||
- 当新增组件或者修改原有组件时,记得增加或者修改对应的单元测试,保证代码的稳定。
|
||||
- 在 PR 中请添加合适的描述,并关联相关的 Issue。
|
||||
|
||||
@@ -129,7 +128,7 @@ src
|
||||
提 Pull Request 前,请依照下面的流程同步主仓库的最新代码:
|
||||
|
||||
```bash
|
||||
# 添加主仓库到 remote,作为 fork 后仓库的上游仓库
|
||||
# 添加主仓库到 remote
|
||||
git remote add upstream git@github.com:vant-ui/vant.git
|
||||
|
||||
# 拉取主仓库最新代码
|
||||
|
||||
Reference in New Issue
Block a user