axe-ui组件库贡献文档 #19
Labels
good first issue
Good for newcomers
priority:low
优先级-低
type:documentation
Improvements or additions to documentation
Milestone
技术栈
目录结构
依赖安装
1、环境和工具要求
node
: 8.9+ (推荐 10+)npm
: 6+MinGW
:最新即可,安装教程参照MinGW的安装与make命令的使用git-cz
: 最新版2-1、升级cli【必要!】
本项目是使用vue-cli搭建项目框架,需要用vue3,得先把vue-cli的版本升级到
vue-cli@4.5
以上:可以先使用
vue --version
命令来查看下版本,如果不是4.5+的请一定升级。2-2、配置工具环境
git-cz
用于代替“git commit”,启用commitizen
来交互式地生成更符合规范的commit信息。全局安装命令如下:
3、安装/更新依赖:
host配置
因为服务启动后需要访问域名,故可以先进行配置:
【重要】开始开发前
fork
代码开始开发。(防止和别人重复开发)开始开发
自动化创建新组件
component-name
:组件名,中横线命名法。如:button、button-group组件中文名
:可选,建议有。# demo: make new radio 单选框 make new radio-group 单选框组
强烈推荐使用make命令开发!关于
make
命令的使用见这里MinGW的安装与make命令的使用启动文档平台
整个axe-ui平台启动,适用源码开发、文档编写。
浏览地址
启动成功后在浏览器中打开 http://dev.axe-ui.com:8080/ 导航至相应组件即可进行开发。
源码地址:
packages/
开发中规范与注意事项
开发中请注意这些问题和遵守这些代码规范
开发完成后
• 如果是修复 bug,请确保该组件的其他功能没有受到本修复的影响。
• 如果是新增功能,请在文档中补充该功能的 API 说明,并在 TypeScript 定义中添加该 API。视功能的复杂程度,有时还需要添加测试用例和文档例子。
单元测试
在提交代码前,建议首先在本地运行一遍测试。
使用下列命令,即可进行测试,并且在你改变代码后会再次触发测试。
代码校验和修复
提交代码
强烈推荐使用命令commit提交符合规范的信息,不再推荐使用
git commit
。npm run commit # or make commit
交互式生成信息demo
![交互式生成信息demo](https://camo.githubusercontent.com/20d2bdc39fe801b162a3eca1d19b3ccc9f48c3ebc9091b16698c572e3f957f49/68747470733a2f2f696d676b72322e636e2d626a2e7566696c656f732e636f6d2f63346333346334392d316339632d343030642d623734382d3263323432396538366636332e706e673f55436c6f75645075626c69634b65793d544f4b454e5f38643862373262652d353739612d346538332d626664302d356636636531353436663133265369676e61747572653d6445664567253235324261565a34673650356561614525323532462532353246576f5067636c49253235334426457870697265733d31363036393239383237)
若非要使用
git commit
,请在 commit 代码时,commit message 请遵循以下格式:commit 类型只允许以下7种个标识:
feat
:新功能(feature)fix
:修补bugdocs
:文档(documentation)style
: 格式(不影响代码运行的变动)refactor
:重构(即不是新增功能,也不是修改bug的代码变动)test
:增加测试chore
:构建过程或辅助工具的变动生产环境(打包+压缩)
生成dist文件
npm run dist # or make dist
发包
请先去NPM注册一个自己的账号:https://www.npmjs.com/
或使用下边命令注册
然后在项目根目录命令行执行一键发布命令:
npm run pub # or make pub
The text was updated successfully, but these errors were encountered: