如何讓你的開源項(xiàng)目更有展現(xiàn)力?
播種希望
今天講的內(nèi)容不是純純的技術(shù)干貨, 而是筆者在做開源項(xiàng)目中用到的一些工具, 可以讓我們的開源項(xiàng)目更加富有展現(xiàn)力, 最后會(huì)同步一下H5-Dooring 頁(yè)面編輯器和V6.Dooring可視化大屏編輯器的一些更新.
如何讓你的開源項(xiàng)目有個(gè)漂亮的README.md ?
逛了一圈社區(qū)之后筆者發(fā)現(xiàn)了readme-md-generator
readme-md-generator通過(guò)閱讀我們的package.json和git配置來(lái)建議我們使用對(duì)應(yīng)的readme結(jié)構(gòu)。
產(chǎn)生的README.md類似如下展現(xiàn)：
另外, 一個(gè)優(yōu)秀的package.json應(yīng)該包含如下幾個(gè)元數(shù)據(jù):
{
"name": "H5-Dooring",
"version": "1.1.3",
"description": "H5-Dooring是一款功能強(qiáng)大，開源免費(fèi)的H5可視化頁(yè)面配置解決方案，致力于提供一套簡(jiǎn)單方便、專業(yè)可靠、無(wú)限可能的H5落地頁(yè)最佳實(shí)踐。技術(shù)棧以react為主， 后臺(tái)采用nodejs開發(fā)。",
"author": "作者信息",
"license": "開源協(xié)議",
"homepage": "主頁(yè)地址",
"repository": {
"type": "git",
"url": "git倉(cāng)庫(kù)地址"
},
"bugs": {
"url": "供他人提issue的地址"
},
"engines": {
"npm": ">=5.5.0",
"node": ">=9.3.0"
}
}
大家在做開源項(xiàng)目的時(shí)候也可以參考如上規(guī)范, 讓自己的開源項(xiàng)目更可靠健壯吧~
使用git-emoji讓你的代碼提交可視化
git-emoji是git 提交信息的 emoji 指南, 我們按照它的規(guī)范提交log日志, 將會(huì)生成形象易懂的提交表情, 如下:
我們看到的比較有名的開源項(xiàng)目提交都會(huì)有形象的emoji, 也都是遵循了對(duì)應(yīng)的提交規(guī)范. 下面是它的介紹網(wǎng)站:
在線地址: https://gitmoji.js.org/
我們可以使用它的指南來(lái)輕松優(yōu)化我們開源的提交log, 趕緊來(lái)試試吧~
H5-Dooring編輯器更新日志
添加條形碼組件 修復(fù)多頁(yè)面跳轉(zhuǎn)關(guān)聯(lián)bug 修復(fù)組件交互中富文本編輯切換bug 數(shù)據(jù)可視化大屏發(fā)布
近期規(guī)劃
dooring2.0版本規(guī)劃 表單設(shè)計(jì)器添加插入功能 添加組件動(dòng)畫 優(yōu)化DSL結(jié)構(gòu), 渲染器 支持下載源碼
地址: http://h5.dooring.cn
V6.Dooring更新日志
目前開放內(nèi)測(cè)版供大家測(cè)試學(xué)習(xí), 后期會(huì)持續(xù)優(yōu)化bug和迭代功能, 敬請(qǐng)期待.
地址: http://175.27.130.220:3001/beta