diff --git a/packages/vant/docs/markdown/contribution.zh-CN.md b/packages/vant/docs/markdown/contribution.zh-CN.md index e471e9c26..1c38e9c80 100644 --- a/packages/vant/docs/markdown/contribution.zh-CN.md +++ b/packages/vant/docs/markdown/contribution.zh-CN.md @@ -8,8 +8,8 @@ ### Issue 规范 -- 遇到问题时,请先确认这个问题是否已经在 issue 中有记录或者已被修复 -- 提 issue 时,请用简短的语言描述遇到的问题,并添加出现问题时的环境和复现步骤 +- 遇到问题时,请先确认这个问题是否已经在 issue 中有记录或者已被修复。 +- 提 issue 时,请用简短的语言描述遇到的问题,并添加出现问题时的环境和复现步骤。 ## 参与开发 @@ -71,28 +71,38 @@ src └─ README.zh-CN.md # 中文文档 ``` +### 代码规范 + +在编写代码时,请注意: + +- 确保代码可以通过仓库的 ESLint 和 Stylelint 校验。 +- 确保代码格式是规范的,使用 prettier 进行代码格式化。 +- 确保没有使用超出兼容性范围的 API,比如 `async/await`。 + ## 提交 PR -### Pull Request 规范 +### 参考指南 如果你是第一次在 GitHub 上提 Pull Request ,可以阅读下面这两篇文章来学习: - [如何优雅地在 GitHub 上贡献代码](https://segmentfault.com/a/1190000000736629) - [第一次参与开源](https://github.com/firstcontributions/first-contributions/blob/master/translations/README.chs.md) -#### 规范 +### Pull Request 规范 -- 如果遇到问题,建议保持你的 PR 足够小。保证一个 PR 只解决一个问题或只添加一个功能 -- 当新增组件或者修改原有组件时,记得增加或者修改测试代码,保证代码的稳定 -- 在 PR 中请添加合适的描述,并关联相关的 Issue +在提交 Pull Request 时,请注意: + +- 如果遇到问题,建议保持你的 PR 足够小。保证一个 PR 只解决单个问题、添加单个功能。 +- 当新增组件或者修改原有组件时,记得增加或者修改对应的单元测试,保证代码的稳定。 +- 在 PR 中请添加合适的描述,并关联相关的 Issue。 ### Pull Request 流程 -1. fork 主仓库,如果已经 fork 过,请同步主仓库的最新代码 -2. 基于 fork 后仓库的 dev 分支新建一个分支,比如 `feature/button_color` -3. 在新分支上进行开发,开发完成后,提 Pull Request 到主仓库的 dev 分支 -4. Pull Request 会在 Review 通过后被合并到主仓库 -5. 等待 Vant 发布版本,一般是每周一次 +1. fork 主仓库,如果已经 fork 过,请同步主仓库的最新代码。 +2. 基于 fork 后仓库的 dev 分支新建一个分支,比如 `feature/button_color`。 +3. 在新分支上进行开发,开发完成后,提 Pull Request 到主仓库的 dev 分支。 +4. Pull Request 会在 Review 通过后被合并到主仓库。 +5. 等待 Vant 发布新版本,一般是每周一次。 ### 同步最新代码