如何讓你的開源項目有個漂亮的README.md ?

?[[414438]]?

逛了一圈社區之后筆者發現了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和迭代功能, 敬請期待.