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

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

​[[414438]]​

蒙城网站制作公司哪家好，找成都创新互联！从网页设计、网站建设、微信开发、APP开发、成都响应式网站建设等网站项目制作，到程序开发，运营维护。成都创新互联成立与2013年到现在10年的时间，我们拥有了丰富的建站经验和运维经验，来保证我们的工作的顺利进行。专注于网站建设就选成都创新互联。

逛了一圈社区之后笔者发现了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编辑器更新日志

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

近期规划

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

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

V6.Dooring更新日志

后期会持续优化bug和迭代功能, 敬请期待.

分享题目：如何让你的开源项目更有展现力？
URL地址：http://www.kswsj.com/qtweb/news45/55845.html

网站建设、网络推广公司-成都快上网，一家网站设计、网站制作公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 成都快上网