docs: update contribution guide (#8826)

This commit is contained in:
neverland 2021-06-08 09:53:33 +08:00 committed by GitHub
parent bedf05bc58
commit eef67b2c5f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 25 additions and 20 deletions

View File

@ -67,7 +67,7 @@ vant 也支持按需引入、CDN 引入等方式,详细说明见 [快速上手
## 贡献代码 ## 贡献代码
修改代码请阅读我们的 [开发指南](https://vant-contrib.gitee.io/vant/#/zh-CN/contribution)。 修改代码请阅读我们的 [贡献指南](https://vant-contrib.gitee.io/vant/#/zh-CN/contribution)。
使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们,当然,我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。 使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们,当然,我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。

View File

@ -1,4 +1,4 @@
# 开发指南 # 贡献指南
### 介绍 ### 介绍
@ -32,22 +32,20 @@ npm run dev
### 目录结构 ### 目录结构
- 仓库的组件代码位于 src 下,每个组件一个文件夹 项目的主要目录结构如下所示:
- docs 目录下是文档网站的代码,本地开发时可以在目录下运行 npm run dev 开启文档网站
项目主要目录如下:
``` ```
vant vant
├─ build # 构建 ├─ docs # 文档
├─ docs # 文档 ├─ packages # 基础包
├─ src # 组件 ├─ src # 组件源代码
├─ packages # 子包 ├─ test # 单测工具类
├─ test # 单测 └─ vant.config.js # 文档网站配置
└─ types # 类型
``` ```
### 添加新组件 组件代码位于 src 目录下,每个组件一个独立的文件夹。
### 组件目录结构
添加新组件时,请按照下面的目录结构组织文件,并在 `vant.config.js` 中配置组件名称。 添加新组件时,请按照下面的目录结构组织文件,并在 `vant.config.js` 中配置组件名称。
@ -56,8 +54,10 @@ src
└─ button └─ button
├─ demo # 示例代码 ├─ demo # 示例代码
├─ test # 单元测试 ├─ test # 单元测试
├─ index.js # 组件入口 ├─ Component.ts # 组件
├─ index.less # 组件样式 ├─ index.ts # 组件入口
├─ index.less # 样式
├─ var.less # 样式变量
├─ README.md # 英文文档 ├─ README.md # 英文文档
└─ README.zh-CN.md # 中文文档 └─ README.zh-CN.md # 中文文档
``` ```
@ -66,6 +66,10 @@ src
### Pull Request 规范 ### Pull Request 规范
如果你是第一次在 GitHub 上提 Pull Request ,可以阅读下面这篇文章来学习:[如何优雅地在 GitHub 上贡献代码](https://segmentfault.com/a/1190000000736629)。
#### 规范
- 如果遇到问题,建议保持你的 PR 足够小。保证一个 PR 只解决一个问题或只添加一个功能 - 如果遇到问题,建议保持你的 PR 足够小。保证一个 PR 只解决一个问题或只添加一个功能
- 当新增组件或者修改原有组件时,记得增加或者修改测试代码,保证代码的稳定 - 当新增组件或者修改原有组件时,记得增加或者修改测试代码,保证代码的稳定
- 在 PR 中请添加合适的描述,并关联相关的 Issue - 在 PR 中请添加合适的描述,并关联相关的 Issue
@ -73,7 +77,7 @@ src
### Pull Request 流程 ### Pull Request 流程
1. fork 主仓库,如果已经 fork 过,请同步主仓库的最新代码 1. fork 主仓库,如果已经 fork 过,请同步主仓库的最新代码
2. 基于 fork 后仓库的 dev 分支新建一个分支,比如`feature/button_color` 2. 基于 fork 后仓库的 dev 分支新建一个分支,比如 `feature/button_color`
3. 在新分支上进行开发,开发完成后,提 Pull Request 到主仓库的 dev 分支 3. 在新分支上进行开发,开发完成后,提 Pull Request 到主仓库的 dev 分支
4. Pull Request 会在 Review 通过后被合并到主仓库 4. Pull Request 会在 Review 通过后被合并到主仓库
5. 等待 Vant 发布版本,一般是每周一次 5. 等待 Vant 发布版本,一般是每周一次

View File

@ -31,7 +31,7 @@ Vant 是**有赞前端团队**开源的移动端组件库,于 2017 年开源
### 贡献代码 ### 贡献代码
修改代码请阅读我们的[开发指南](#/zh-CN/contribution)。 贡献代码请阅读我们的[贡献指南](#/zh-CN/contribution)。
使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们,当然,我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。 使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们,当然,我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。

View File

@ -168,8 +168,9 @@ export default {
border-top: 1px solid #eee; border-top: 1px solid #eee;
} }
> p > code, > p code,
> ul li > code, > ul code,
> ol code,
> table code { > table code {
display: inline; display: inline;
margin: 0 2px; margin: 0 2px;

View File

@ -92,7 +92,7 @@ module.exports = {
}, },
{ {
path: 'contribution', path: 'contribution',
title: '开发指南', title: '贡献指南',
}, },
{ {
path: 'design', path: 'design',