摘要:前言最近在弄自己的項目,這幾天將他美化了一下。咱們前端項目不需要后臺,真的非常合適部署在上。用于檢查項目的是否符合格式。參考項目徽章的添加和設置和編寫指南其他當然,后續如果你的項目有其他的人參與進來,一份模板,和模板也是不能少的。
前言
最近在弄自己的github項目,這幾天將他美化了一下。于是就有了這篇文章。雖然這些工作不會讓你的項目變得牛逼,但會讓你的項目變得漂亮,方便了其他人去了解你這個項目
READMEREADME 是用戶點進你項目的第一印象,值得你去學習一下如何寫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模板也是不能少的。
你有什么花里胡哨的技巧,不妨評論區告訴我吧
關于我一個一年小前端,關注我的微信公眾號,和我一起交流,我會盡我所能,并且看看我能成長成什么樣子吧。交個朋友吧!
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://m.specialneedsforspecialkids.com/yun/109971.html
摘要:在云計算日益成熟和普及的今天,共享經濟的理念不斷的為人們所理解和接受。作者在書中,提出了云計算經濟學的三個核心定律。云計算與自建基礎設施哪個更經濟這個問題,也是目前比較有爭議的。 在云計算日益成熟和普及的今天,共享經濟的理念不斷的為人們所理解和接受。云逐漸由一種技術,演化成了一種商業模式,以及一種經濟學現象。Joe Weinman在其大作《云經濟學》一書中,創造性地提出了Cloudonomi...
摘要:下面列舉了游戲開發中常見的崗位以及兩條常見的協作開發的流水線其實學習游戲引擎,前期對于任何崗位來說路線都是相似的,基本上就是一個熟悉基本操作理解基本概念拓展專業知識的過程。當然這不是絕對的,任何引擎的開始階段和大成階段都是相似的。 這是【游戲開發那些事】第51篇原創 前言:游戲引擎,表面...
摘要:番茄工作法簡約而不簡單,本書亦然。在番茄工作法一個個短短的分鐘內,你收獲的不僅僅是效率,還會有意想不到的成就感。 @author ASCE1885的 Github 簡書 微博 CSDN 知乎本文由于潛在的商業目的,不開放全文轉載許可,謝謝! showImg(/img/remote/1460000007319503?w=728&h=792); 廣而告之時間:我的新書《Android 高...
摘要:這里推薦一本書源碼剖析源碼剖析豆瓣這本書把源碼中最核心的部分,給出了詳細的闡釋,不過閱讀此書需要對語言內存模型和指針有著很好的理解。 是否非常想學好 Python,一方面被瑣事糾纏,一直沒能動手,另一方面,擔心學習成本太高,心里默默敲著退堂鼓? 幸運的是,Python 是一門初學者友好的編程語言,想要完全掌握它,你不必花上太多的時間和精力。 Python 的設計哲學之一就是...
閱讀 1623·2021-11-16 11:45
閱讀 2554·2021-09-29 09:48
閱讀 3320·2021-09-07 10:26
閱讀 1847·2021-08-16 10:50
閱讀 1877·2019-08-30 15:44
閱讀 2705·2019-08-28 18:03
閱讀 1906·2019-08-27 10:54
閱讀 1832·2019-08-26 14:01