如何做好一个开源项目之徽章（二）
在上一篇【如何做好一個(gè)開源項(xiàng)目（一）】，筆者已經(jīng)介紹過開源項(xiàng)目運(yùn)作和維護(hù)的一些理念了，本篇開始，筆者將著重于介紹一些開源項(xiàng)目維護(hù)過程中的一些細(xì)節(jié)，比如徽章、構(gòu)建等等。由于最近經(jīng)常出差，所以博客有中斷，非常抱歉。
什么是項(xiàng)目徽章？
我們辛苦維護(hù)自己的開源項(xiàng)目，但是如何能夠簡要的向其他人描述一些項(xiàng)目的相關(guān)信息呢？文字、代碼的表達(dá)方式都是有限的，篇幅過多的話，增加閱讀難度又使訪問者無法聚焦。這時(shí)候是時(shí)候可以祭出徽章了，我們可以通過徽章來展示項(xiàng)目的一些相關(guān)信息，讓訪問者知道這個(gè)項(xiàng)目的一些信息，以及項(xiàng)目團(tuán)隊(duì)一直在持續(xù)維護(hù)。
那么什么是項(xiàng)目徽章？項(xiàng)目徽章是根據(jù)項(xiàng)目情況生成的一些小圖標(biāo)，一般在Readme.md里面通過Markdown語法進(jìn)行添加。這些圖標(biāo)一般簡潔美觀，而且還包含了項(xiàng)目相關(guān)的一些清晰易讀的信息。簡言之，徽章就是添加一些花里胡哨的可以帶鏈接和項(xiàng)目信息的小圖標(biāo)，以增加開源項(xiàng)目的炫酷程度，添加同性交友的幾率。
接下來，我們繼續(xù)基于Magicodes.IE來進(jìn)行舉例說明。
地址：
https://github.com/dotnetcore/Magicodes.IE
GitHub徽章
如上圖所示，這是Magicodes.IE的GitHub徽章。該徽章使用 http://shields.io/?進(jìn)行添加，我們可以在該網(wǎng)站預(yù)覽絕大部分的徽標(biāo)樣式，然后選擇自己喜歡的（當(dāng)然首先需要適用于自己的目標(biāo)項(xiàng)目）徽標(biāo)，添加到自己的項(xiàng)目文檔中。
打開網(wǎng)站：http://shields.io/，我們就可以看到各種各樣的徽章設(shè)置：
該網(wǎng)站支持非常多的類型的徽章，如上圖所示的藍(lán)色鏈接，比如Build（構(gòu)建）、Code Coverage（代碼覆蓋）、Analysis（分析）等等類型。點(diǎn)擊圖標(biāo)，就可以設(shè)置自己的參數(shù)（比如用戶名和倉庫名），然后生成徽章了，如下圖所示：
操作非常簡單，而且還可以自定義整個(gè)徽章。
如何添加持續(xù)集成的徽章？
如下圖Magicodes.IE的徽章所示，如何添加這些徽章呢？
CI的徽章是很有必要的，一目了然的了解了項(xiàng)目的代碼覆蓋率、構(gòu)建狀態(tài)和單元測試狀況，那么如何來裝這個(gè)B呢？這個(gè)就需要看CI平臺(tái)了，基本上都提供了渠道。比如Azure DevOps：
代碼覆蓋率、單元測試狀況呢？這個(gè)就要回到剛才的Shields站點(diǎn)了：
如何添加貢獻(xiàn)者的徽章？
這就需要在https://opencollective.com/為項(xiàng)目注冊(cè)一個(gè)賬戶，然后就可以添加如下圖所示的徽章了：
如何添加Nuget包的徽章？
這就不得不提到BuildStats.info了。
網(wǎng)址：
https://buildstats.info/
GitHub地址：
https://github.com/dustinmoris/CI-BuildStats
配置起來也超級(jí)簡單：
還支持構(gòu)建歷史的徽章。如上圖所示，我們可以通過參數(shù)配置顯示預(yù)發(fā)布的包的版本：
最后
徽章用得好，項(xiàng)目增色不少。以上內(nèi)容僅為拋磚引玉，你也可以試試。
轉(zhuǎn)載是一種動(dòng)力 分享是一種美德
如果喜歡作者的文章，請(qǐng)關(guān)注【麥扣聊技術(shù)】訂閱號(hào)以便第一時(shí)間獲得最新內(nèi)容。本文版權(quán)歸作者和湖南心萊信息科技有限公司共有，歡迎轉(zhuǎn)載，但未經(jīng)作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責(zé)任的權(quán)利。
文檔官網(wǎng)：docs.xin-lai.com
QQ群：
編程交流群<85318032>?
產(chǎn)品交流群<897857351>
總結(jié)
以上是生活随笔為你收集整理的如何做好一个开源项目之徽章（二）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： .NET Core API文档管理组件
- 下一篇： 国际化组件 Unicode (ICU)