在上一篇【如何做好一個開源項目（一）】，筆者已經介紹過開源項目運作和維護的一些理念了，本篇開始，筆者將著重于介紹一些開源項目維護過程中的一些細節，比如徽章、構建等等。由于最近經常出差，所以博客有中斷，非常抱歉。

什么是項目徽章？

我們辛苦維護自己的開源項目，但是如何能夠簡要的向其他人描述一些項目的相關信息呢？文字、代碼的表達方式都是有限的，篇幅過多的話，增加閱讀難度又使訪問者無法聚焦。這時候是時候可以祭出徽章了，我們可以通過徽章來展示項目的一些相關信息，讓訪問者知道這個項目的一些信息，以及項目團隊一直在持續維護。

那么什么是項目徽章？項目徽章是根據項目情況生成的一些小圖標，一般在Readme.md里面通過Markdown語法進行添加。這些圖標一般簡潔美觀，而且還包含了項目相關的一些清晰易讀的信息。簡言之，徽章就是添加一些花里胡哨的可以帶鏈接和項目信息的小圖標，以增加開源項目的炫酷程度，添加同性交友的幾率。

接下來，我們繼續基于Magicodes.IE來進行舉例說明。

地址：

https://github.com/dotnetcore/Magicodes.IE

GitHub徽章

如上圖所示，這是Magicodes.IE的GitHub徽章。該徽章使用 http://shields.io/?進行添加，我們可以在該網站預覽絕大部分的徽標樣式，然后選擇自己喜歡的（當然首先需要適用于自己的目標項目）徽標，添加到自己的項目文檔中。

打開網站：http://shields.io/，我們就可以看到各種各樣的徽章設置：

該網站支持非常多的類型的徽章，如上圖所示的藍色鏈接，比如Build（構建）、Code Coverage（代碼覆蓋）、Analysis（分析）等等類型。點擊圖標，就可以設置自己的參數（比如用戶名和倉庫名），然后生成徽章了，如下圖所示：

操作非常簡單，而且還可以自定義整個徽章。

如何添加持續集成的徽章？

如下圖Magicodes.IE的徽章所示，如何添加這些徽章呢？

CI的徽章是很有必要的，一目了然的了解了項目的代碼覆蓋率、構建狀態和單元測試狀況，那么如何來裝這個B呢？這個就需要看CI平臺了，基本上都提供了渠道。比如Azure DevOps：

代碼覆蓋率、單元測試狀況呢？這個就要回到剛才的Shields站點了：

如何添加貢獻者的徽章？

這就需要在https://opencollective.com/為項目注冊一個賬戶，然后就可以添加如下圖所示的徽章了：

如何添加Nuget包的徽章？

這就不得不提到BuildStats.info了。

網址：

https://buildstats.info/

GitHub地址：

https://github.com/dustinmoris/CI-BuildStats

配置起來也超級簡單：

還支持構建歷史的徽章。如上圖所示，我們可以通過參數配置顯示預發布的包的版本：

最后

徽章用得好，項目增色不少。以上內容僅為拋磚引玉，你也可以試試。

轉載是一種動力 分享是一種美德

如果喜歡作者的文章，請關注【麥扣聊技術】訂閱號以便第一時間獲得最新內容。本文版權歸作者和湖南心萊信息科技有限公司共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責任的權利。

文檔官網：docs.xin-lai.com

QQ群：

編程交流群<85318032>?

產品交流群<897857351>

總結

以上是生活随笔為你收集整理的如何做好一个开源项目之徽章（二）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。