如何让你的开源项目有个美丽的README.md ?
逛了一圈社区之后笔者发现了readme-md-generator
readme-md-generator经过阅读我们的package.json和git配置来建议我们运用对应的readme结构。
产生的README.md相似如下展现：
另外, 一个优秀的package.json应该包含如下几个元数据:
{
"name": "H5-Dooring",
"version": "1.1.3",
"description": "H5-Dooring是一款功用弱小，开源收费的H5可视化页面配置处置方案，努力于提供一套复杂方便、专业牢靠、有限能够的H5落地页最佳实际。技术栈以react为主， 后台采用nodejs开发。",
"author": "作者信息",
"license": "开源协议",
"homepage": "主页地址",
"repository": {
"type": "git",
"url": "git仓库地址"
},
"bugs": {
"url": "供别人提issue的地址"
},
"engines": {
"npm": ">=5.5.0",
"node": ">=9.3.0"
}
}
大家在做开源项目的时分也可以参考如上标准, 让本人的开源项目更牢靠强健吧~
运用git-emoji让你的代码提交可视化git-emoji是git 提交信息的 emoji 指南, 我们按照它的标准提交log日志, 将会生成笼统易懂的提交表情, 如下:
我们看到的比较有名的开源项目提交都会有笼统的emoji, 也都是遵照了对应的提交标准. 下面是它的引见网站:
在线地址: https://gitmoji.js.org/
我们可以运用它的指南来轻松优化我们开源的提交log, 赶忙来试试吧~
H5-Dooring编辑器更新日志
添加条形码组件
修复多页面跳转关联bug
修复组件交互中富文本编辑切换bug
数据可视化大屏发布
近期规划
dooring2.0版本规划
表单设计器添加插入功用
添加组件动画
优化DSL结构, 渲染器
支持下载源码
地址:
V6.Dooring更新日志
前期会继续优化bug和迭代功用, 敬请等候.
【编辑引荐】
高德开放平台SDK率先适配HarmonyOS，面向开发者收费发布
DeepMind开源的AlphaFold怎样用？翻开Colab就能在线用
谷歌要抢苹果用户？将推iOS数据迁移工具，苹果：等你5年了
在家办公网络需求更好的监控工具
CamOver：一款功用弱小的摄像头破绽应用工具
(责任编辑：admin)