摘要:前言最近在弄自己的項(xiàng)目,這幾天將他美化了一下。咱們前端項(xiàng)目不需要后臺(tái),真的非常合適部署在上。用于檢查項(xiàng)目的是否符合格式。參考項(xiàng)目徽章的添加和設(shè)置和編寫指南其他當(dāng)然,后續(xù)如果你的項(xiàng)目有其他的人參與進(jìn)來,一份模板,和模板也是不能少的。
前言
最近在弄自己的github項(xiàng)目,這幾天將他美化了一下。于是就有了這篇文章。雖然這些工作不會(huì)讓你的項(xiàng)目變得牛逼,但會(huì)讓你的項(xiàng)目變得漂亮,方便了其他人去了解你這個(gè)項(xiàng)目
READMEREADME 是用戶點(diǎn)進(jìn)你項(xiàng)目的第一印象,值得你去學(xué)習(xí)一下如何寫readme。當(dāng)然我們自己可能考慮的不是很完全,不如使用工具來生成。推薦readme-md-generator。生成的 README 如下圖:
Logo好的項(xiàng)目第一步就要找一個(gè)比較好看得 logo,現(xiàn)在 AI 自動(dòng)生成 logo 非常火爆。推薦幾個(gè)網(wǎng)站
brandmark
looka
launchaco,這個(gè)是完全免費(fèi)的,雖然 logo 感覺不太好看
designevo,會(huì)給你生成一張基礎(chǔ)的 logo 圖(jpg,和 png),如果你想要更定制的,就要收費(fèi)了
Badge在 README 里面,我們可以添加 Badge(徽章),常用的徽標(biāo)主要有持續(xù)集成狀態(tài)、項(xiàng)目版本信息、代碼測試覆蓋率、項(xiàng)目支持平臺(tái)、項(xiàng)目語言、代碼分析等,想得到這些徽章的話,知道自己該做些什么了吧。
GITHUB PAGE用戶如果感興趣,或許會(huì)想真切地感受一下項(xiàng)目。咱們前端項(xiàng)目不需要后臺(tái),真的非常合適部署在github page上。
Github 彩帶在你的 GITHUB PAGE 上可以添加 Github 彩帶,或者 Github Corner
GIT COMMIT如果你的用戶對你的項(xiàng)目特別感興趣,可能他會(huì)看看你的 commit,看看你寫代碼的過程。如果 commit 信息里面都是 fix , add 甚至 aa,dd 這種無意義的信息,你肯定會(huì)覺得這個(gè)項(xiàng)目的作者不是特別的用心。
angular的commit規(guī)范當(dāng)然作為項(xiàng)目的作者,可能有時(shí)候真的懶。。。。,為了解決這個(gè)問題,推薦大家?guī)讉€(gè)工具。
Commitizen 是一個(gè)撰寫合格 Commit message 的工具。
commitlint 用于檢查 Node 項(xiàng)目的 Commit message 是否符合格式。
changelog如果你的所有 Commit 都符合 Angular 格式,那么發(fā)布新版本時(shí), Change log 就可以用腳本自動(dòng)生成,conventional-changelog 就是生成 Change log 的工具。
參考GitHub 項(xiàng)目徽章的添加和設(shè)置
awesome-bookmarks
Commit message 和 Change log 編寫指南
其他當(dāng)然,后續(xù)如果你的項(xiàng)目有其他的人參與進(jìn)來,一份issue 模板,和pr模板也是不能少的。
你有什么花里胡哨的技巧,不妨評論區(qū)告訴我吧
關(guān)于我一個(gè)一年小前端,關(guān)注我的微信公眾號,和我一起交流,我會(huì)盡我所能,并且看看我能成長成什么樣子吧。交個(gè)朋友吧!
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://specialneedsforspecialkids.com/yun/109971.html
摘要:在云計(jì)算日益成熟和普及的今天,共享經(jīng)濟(jì)的理念不斷的為人們所理解和接受。作者在書中,提出了云計(jì)算經(jīng)濟(jì)學(xué)的三個(gè)核心定律。云計(jì)算與自建基礎(chǔ)設(shè)施哪個(gè)更經(jīng)濟(jì)這個(gè)問題,也是目前比較有爭議的。 在云計(jì)算日益成熟和普及的今天,共享經(jīng)濟(jì)的理念不斷的為人們所理解和接受。云逐漸由一種技術(shù),演化成了一種商業(yè)模式,以及一種經(jīng)濟(jì)學(xué)現(xiàn)象。Joe Weinman在其大作《云經(jīng)濟(jì)學(xué)》一書中,創(chuàng)造性地提出了Cloudonomi...
摘要:下面列舉了游戲開發(fā)中常見的崗位以及兩條常見的協(xié)作開發(fā)的流水線其實(shí)學(xué)習(xí)游戲引擎,前期對于任何崗位來說路線都是相似的,基本上就是一個(gè)熟悉基本操作理解基本概念拓展專業(yè)知識(shí)的過程。當(dāng)然這不是絕對的,任何引擎的開始階段和大成階段都是相似的。 這是【游戲開發(fā)那些事】第51篇原創(chuàng) 前言:游戲引擎,表面...
摘要:番茄工作法簡約而不簡單,本書亦然。在番茄工作法一個(gè)個(gè)短短的分鐘內(nèi),你收獲的不僅僅是效率,還會(huì)有意想不到的成就感。 @author ASCE1885的 Github 簡書 微博 CSDN 知乎本文由于潛在的商業(yè)目的,不開放全文轉(zhuǎn)載許可,謝謝! showImg(/img/remote/1460000007319503?w=728&h=792); 廣而告之時(shí)間:我的新書《Android 高...
摘要:這里推薦一本書源碼剖析源碼剖析豆瓣這本書把源碼中最核心的部分,給出了詳細(xì)的闡釋,不過閱讀此書需要對語言內(nèi)存模型和指針有著很好的理解。 是否非常想學(xué)好 Python,一方面被瑣事糾纏,一直沒能動(dòng)手,另一方面,擔(dān)心學(xué)習(xí)成本太高,心里默默敲著退堂鼓? 幸運(yùn)的是,Python 是一門初學(xué)者友好的編程語言,想要完全掌握它,你不必花上太多的時(shí)間和精力。 Python 的設(shè)計(jì)哲學(xué)之一就是...
閱讀 1614·2021-11-16 11:45
閱讀 2544·2021-09-29 09:48
閱讀 3269·2021-09-07 10:26
閱讀 1840·2021-08-16 10:50
閱讀 1866·2019-08-30 15:44
閱讀 2698·2019-08-28 18:03
閱讀 1898·2019-08-27 10:54
閱讀 1822·2019-08-26 14:01