Skip to content
This repository has been archived by the owner on Oct 27, 2021. It is now read-only.

Latest commit

 

History

History
74 lines (53 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

74 lines (53 loc) · 2.61 KB

Taro-UI-Vue 贡献指南

首先感谢您使用 Taro ,Taro 是由凹凸实验室打造的一套遵循 React 语法规范的多端统一开发框架。使用 Taro,我们可以只书写一套代码,再通过 Taro 的编译工具,将源代码分别编译出可以在不同端(微信小程序、H5、App 端等)运行的代码。

Taro 目前还在成长,如果您愿意为 Taro-UI-Vue 贡献代码或者反馈使用意见,请阅读以下内容。

Issue

Issues 是用来提交 Bug 或 Feature 相关的内容,一个 Bug Issue 应该由代码问题导致的,可重现的 Bug,并且有比较详细的 Bug 描述信息(Taro 版本号,Taro-UI-Vue 版本号,运行环境等等)。

在提交 Issue 之前,请搜索 github issues 中是否有相同的问题已被提出,谢谢~

Pull requests

第一次提 Pull Request? 您可以学习这套 免费 的课程 How to Contribute to an Open Source Project on GitHub

我们欢迎所有类型的 PR,感谢您愿意花时间贡献代码~

  • 如果是组件相关的 PR,麻烦先创建一个 Issue,这么做是避免大家同时修改同一个问题
  • Fork 一份代码到自己的账号下,请不要直接在仓库中创建分支
  • 基于 dev 创建一个新分支,如果你想添加新的组件,分支的命名请使用 feature_component_[Component Name]。(例如:feature_component_list
  • Git Commit Message 的格式请遵循:feat(Component Name): info about this commit
  • 提交 PR 的时候,请使用 Rebase,这是为了保持 Commit 历史的干净(Merge request 到分支 dev
  • 提交 PR 的时候,请添加一些关于你此次 PR 的描述信息

开发环境

请确保您的 Node 版本是 8.0+,并且 Taro next 升级到最新版 组件打包依赖 rollup,请确保全局安装了 rollup

npm install -g rollup
git clone https://github.com/psaren/taro-ui-vue.git
npm install
# OR
cnpm install

运行项目:

npm run dev:weapp

项目打包:

# 小程序端
npm run build:weapp

# 组件打包
npm run build:rollup

组件测试

测试代码 位于 tests 目录下。 测试的组件位于 tests/components 目录,由src/components 转换而来。

单个组件测试

如果在 src/components 中修改了某个组件,需要进行测试, 假设是 button 组件。

node ./tests/transform-component.js && jest ./tests/unit/button.spec.js

所有组件测试

npm run test

代码规范

项目有引入 ESLint ,请务必按照规范编写代码