如何讓你的開源項(xiàng)目有個(gè)漂亮的README.md ?

?[[414438]]?

蒙城網(wǎng)站制作公司哪家好，找成都創(chuàng)新互聯(lián)！從網(wǎng)頁設(shè)計(jì)、網(wǎng)站建設(shè)、微信開發(fā)、APP開發(fā)、成都響應(yīng)式網(wǎng)站建設(shè)等網(wǎng)站項(xiàng)目制作，到程序開發(fā)，運(yùn)營(yíng)維護(hù)。成都創(chuàng)新互聯(lián)成立與2013年到現(xiàn)在10年的時(shí)間，我們擁有了豐富的建站經(jīng)驗(yàn)和運(yùn)維經(jīng)驗(yàn)，來保證我們的工作的順利進(jìn)行。專注于網(wǎng)站建設(shè)就選成都創(chuàng)新互聯(lián)。

逛了一圈社區(qū)之后筆者發(fā)現(xiàn)了readme-md-generator

readme-md-generator通過閱讀我們的package.json和git配置來建議我們使用對(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可視化頁面配置解決方案，致力于提供一套簡(jiǎn)單方便、專業(yè)可靠、無限可能的H5落地頁最佳實(shí)踐。技術(shù)棧以react為主， 后臺(tái)采用nodejs開發(fā)。",
"author": "作者信息",
"license": "開源協(xié)議",
"homepage": "主頁地址",
"repository": {
"type": "git",
"url": "git倉庫地址"
},
"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/

我們可以使用它的指南來輕松優(yōu)化我們開源的提交log, 趕緊來試試吧~

H5-Dooring編輯器更新日志

 

1. 添加條形碼組件
2. 修復(fù)多頁面跳轉(zhuǎn)關(guān)聯(lián)bug
3. 修復(fù)組件交互中富文本編輯切換bug
4. 數(shù)據(jù)可視化大屏發(fā)布

近期規(guī)劃

1. dooring2.0版本規(guī)劃
2. 表單設(shè)計(jì)器添加插入功能
3. 添加組件動(dòng)畫
4. 優(yōu)化DSL結(jié)構(gòu), 渲染器
5. 支持下載源碼

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

V6.Dooring更新日志

后期會(huì)持續(xù)優(yōu)化bug和迭代功能, 敬請(qǐng)期待.

網(wǎng)頁標(biāo)題：如何讓你的開源項(xiàng)目更有展現(xiàn)力？
網(wǎng)頁地址：http://uogjgqi.cn/article/djjpesj.html