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


播种希望

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

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

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

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

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


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

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

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

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

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


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


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

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

H5-Dooring编辑器更新日志


近期规划

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

V6.Dooring更新日志


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

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

相关内容