参与贡献

开发者可以一起参与为tinper-bee贡献代码,同时也可以基于tinper-bee进行二次开发或封装插件。这边文章简要介绍组件库代码管理,提交issue,如何开发一个标准组件等问题

issue 的提交

在你发现组件 bug 或者 希望组件增加一些功能的时候,可以通过提交issue的方法告知我们。在提交issue的时候,为了更方便的了解你的问题,我们希望你能提供信息: 点击这里提交给我们

  1. ## 环境及版本信息
  2. - `tinper-bee` 版本号:
  3. <!-- 请填具体版本号 -->
  4. - 若使用单个组件,请标明该组件版本号:
  5. <!-- 请填具体版本号 -->
  6. - 当前项目中`react`的版本号:
  7. <!-- 请填具体版本号 -->
  8. - 所使用的操作系统:
  9. <!-- Windows/Mac -->
  10. - 所使用的浏览器:
  11. <!-- 浏览器及版本 -->
  12. ## 描述这个问题:
  13. ### 代码
  14. <!-- 请详细说明问题 -->
  15. <!-- 截图说明 -->
  16. ### 报错信息
  17. <!-- 请详细说明问题 -->
  18. <!-- 截图说明 -->
  19. ## 当前的行为:效果(可截图说明)及动作描述
  20. <!-- 请详细描述当前行为,以便我们复现及定位问题 -->
  21. <!-- 截图说明 -->
  22. ## 期望的行为:
  23. <!-- 请详细描述期望达到的行为及效果,以便我们准确理解需求 -->

组件库分支管理

我们的发布的组件都基于master。如果你要修改一个bug,请向master提交pull request。如果你要增加一个新功能,请重新开分支,并向我们说明,我们评估过后合并到master分支并发布新版本

如何提交 pull request

如果你对github pull request不熟悉,请先阅读说明。我们会持续关注 pull request

如何开发一个标准的组件

我们组件都是使用 bee-tools脚手架来开发的。bee-tools 具备以下功能:

# Scripts 脚本命令 Description 功能描述
1 bee-tools run dev 打开浏览器,调试代码和demo
2 bee-tools run build 打包代码到build文件夹
3 bee-tools run dep 下载依赖
4 bee-tools run update 更新依赖
5 bee-tools run pub 集成了(发布npm包、提交github、生成changelog)功能
6 bee-tools run changelogInit 初始化cz-conventional-changelog
7 bee-tools run changelog 生成CHANGELOG.md
8 bee-tools create ac-xx/bee-xx 创建项目(应用组件、基础组件)
9 bee-tools run releases 创建releases

这里我们提供了详细的组件开发文档、代码规范、组件库的简介等

问题反馈

如在使用过程中遇到任何问题,可以在这里提交issue反馈

或者直接fork代码到你的github仓库,提交pull request给我们。

有紧急问题可以直接邮件给我们(Email:guoyff@yonyou.com)