如何讓你的 GitHub 項目表面上更專業

前言

最近在弄本身的github項目，這幾天將他美化了一下。因而就有了這篇文章。雖然這些工做不會讓你的項目變得牛逼，但會讓你的項目變得漂亮，方便了其餘人去了解你這個項目

README

README 是用戶點進你項目的第一印象，值得你去學習一下如何寫readme。固然咱們本身可能考慮的不是很徹底，不如使用工具來生成。推薦readme-md-generator。生成的 README 以下圖：

Logo

好的項目第一步就要找一個比較好看得 logo，如今 AI 自動生成 logo 很是火爆。推薦幾個網站

• brandmark
• looka
• launchaco，這個是徹底免費的，雖然 logo 感受不太好看
• designevo，會給你生成一張基礎的 logo 圖（jpg，和 png），若是你想要更定製的，就要收費了

Badge

在 README 裏面，咱們能夠添加 Badge(徽章)，經常使用的徽標主要有持續集成狀態、項目版本信息、代碼測試覆蓋率、項目支持平臺、項目語言、代碼分析等，想獲得這些徽章的話，知道本身該作些什麼了吧。

GITHUB PAGE

用戶若是感興趣，或許會想真切地感覺一下項目。我們前端項目不須要後臺，真的很是合適部署在github page上。

Github 綵帶

在你的 GITHUB PAGE 上能夠添加 Github 綵帶，或者 Github Corner

GIT COMMIT

若是你的用戶對你的項目特別感興趣，可能他會看看你的 commit，看看你寫代碼的過程。若是 commit 信息裏面都是 fix , add 甚至 aa,dd 這種無心義的信息，你確定會以爲這個項目的做者不是特別的用心。

angular的commit規範

固然做爲項目的做者，可能有時候真的懶。。。。，爲了解決這個問題，推薦你們幾個工具。

• Commitizen 是一個撰寫合格 Commit message 的工具。
• commitlint 用於檢查 Node 項目的 Commit message 是否符合格式。

changelog

若是你的全部 Commit 都符合 Angular 格式，那麼發佈新版本時， Change log 就能夠用腳本自動生成，conventional-changelog 就是生成 Change log 的工具。

參考

• GitHub 項目徽章的添加和設置
• awesome-bookmarks
• Commit message 和 Change log 編寫指南

其餘

固然，後續若是你的項目有其餘的人蔘與進來，一份issue 模板，和pr模板也是不能少的。

你有什麼花裏胡哨的技巧，不妨評論區告訴我吧

關於我

一個一年小前端，關注個人微信公衆號，和我一塊兒交流，我會盡我所能，而且看看我能成長成什麼樣子吧。交個朋友吧！