当前位置: 首页 > 科技观察

如何让你的开源项目更具表现力?

时间:2023-03-14 20:53:26 科技观察

如何让你的开源项目拥有漂亮的README.md?笔者浏览社区后发现readme-md-generatorreadme-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":"首页地址","re??pository":{"type":"git","url":"git仓库地址"},"bugs":{"url":"其他人提issue的地址"},"engines":{"npm":">=5.5.0","node":">=9.3.0"}}你在做开源项目的时候也可以参考上面的规范,让你的开源项目更加可靠健壮~使用git-emoji可视化你的代码提交git-emoji是git的emoji指南提交信息,我们按照其规范的提交日志,会生成通俗易懂的提交表情,如下:它的介绍网址:在线地址:https://gitmoji.js.org/我们可以使用它的指南轻松优化我们的开源提交日志,快来试试吧~H5-Dooring编辑器更新日志添加条码组件ent修复多页跳转关联Bug修复富文本编辑切换组件交互bug数据可视化大屏发布近期规划dooring2.0版本规划表单设计器新增插入功能新增组件动画优化DSL结构,渲染器支持下载源码地址:http://h5.dooring.cnV6.Dooring后期会在更新日志中继续优化bug和迭代功能,敬请期待。