程序员

如何让你的开源项目更有展现力?

作者:admin 2021-04-22 我要评论

播种希望 今天讲的内容不是纯纯的技术干货, 而是笔者在做开源项目中用到的一些工具, 可以让我们的开源项目更加富有展现力, 最后会同步一下H5-Dooring 页面编辑器...

在说正事之前,我要推荐一个福利:你还在原价购买阿里云、腾讯云、华为云服务器吗?那太亏啦!来这里,新购、升级、续费都打折,能够为您省60%的钱呢!2核4G企业级云服务器低至69元/年,点击进去看看吧>>>)

播种希望

今天讲的内容不是纯纯的技术干货, 而是笔者在做开源项目中用到的一些工具, 可以让我们的开源项目更加富有展现力, 最后会同步一下H5-Dooring 页面编辑器和V6.Dooring可视化大屏编辑器的一些更新.

如何让你的开源项目有个漂亮的README.md ?

逛了一圈社区之后笔者发现了readme-md-generator

  • readme-md-generator通过阅读我们的package.json和git配置来建议我们使用对应的readme结构。

产生的README.md类似如下展现:


另外, 一个优秀的package.json应该包含如下几个元数据:

  1.   "name""H5-Dooring"
  2.   "version""1.1.3"
  3.   "description""H5-Dooring是一款功能强大,开源免费的H5可视化页面配置解决方案,致力于提供一套简单方便、专业可靠、无限可能的H5落地页最佳实践。技术栈以react为主, 后台采用nodejs开发。"
  4.   "author""作者信息"
  5.   "license""开源协议"
  6.   "homepage""主页地址"
  7.   "repository": { 
  8.     "type""git"
  9.     "url""git仓库地址" 
  10.   }, 
  11.   "bugs": { 
  12.     "url""供他人提issue的地址" 
  13.   }, 
  14.   "engines": { 
  15.     "npm"">=5.5.0"
  16.     "node"">=9.3.0" 
  17.   } 

大家在做开源项目的时候也可以参考如上规范, 让自己的开源项目更可靠健壮吧~

使用git-emoji让你的代码提交可视化

git-emoji是git 提交信息的 emoji 指南, 我们按照它的规范提交log日志, 将会生成形象易懂的提交表情, 如下:


我们看到的比较有名的开源项目提交都会有形象的emoji, 也都是遵循了对应的提交规范. 下面是它的介绍网站:


在线地址: https://gitmoji.js.org/

我们可以使用它的指南来轻松优化我们开源的提交log, 赶紧来试试吧~

H5-Dooring编辑器更新日志


  1. 添加条形码组件
  2. 修复多页面跳转关联bug
  3. 修复组件交互中富文本编辑切换bug
  4. 数据可视化大屏发布

近期规划

  1. dooring2.0版本规划
  2. 表单设计器添加插入功能
  3. 添加组件动画
  4. 优化DSL结构, 渲染器
  5. 支持下载源码

地址: http://h5.dooring.cn

V6.Dooring更新日志


目前开放内测版供大家测试学习, 后期会持续优化bug和迭代功能, 敬请期待.

地址: http://175.27.130.220:3001/beta


本文转载自网络,原文链接:https://mp.weixin.qq.com/s/es6aEboA1PFi8jchvFqGvQ

版权声明:本文转载自网络,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。本站转载出于传播更多优秀技术知识之目的,如有侵权请联系QQ/微信:153890879删除

相关文章
  • 天津智慧物联赛道明星结营丨创业不孤独

    天津智慧物联赛道明星结营丨创业不孤独

  • 阿里新零售赛道明星结业,群星集结相伴

    阿里新零售赛道明星结业,群星集结相伴

  • 教育行业优质解决方案分享【智慧校园解

    教育行业优质解决方案分享【智慧校园解

  • Excelize 2.4.0 正式版发布, 新增 152

    Excelize 2.4.0 正式版发布, 新增 152

腾讯云代理商
海外云服务器