title: 如何規(guī)劃創(chuàng)建并長期維護(hù)一個Github開源項(xiàng)目?
tags:

• 開源
• 程序
• Github
• zhaoolee
  categories:
• 極客

2021年, 國內(nèi)各路論壇已經(jīng)鋪滿屠龍寶刀點(diǎn)擊就送的廣告, 知乎這種傳統(tǒng)的知識社區(qū)也完全淪陷, 無論是內(nèi)容質(zhì)量還是產(chǎn)品設(shè)計都大不如前

image

image

image

目前知名度高, 影響力大且干凈的網(wǎng)站只有Github了, Github是全球開發(fā)者最聚集的社區(qū), 里面有很多項(xiàng)目, 無論是996.icu, 還是Chrome插件英雄榜, 或者是表情包都能成為受歡迎的項(xiàng)目, 并吸引各種志同道合的人前來研究...

image

如果想在Github立足, 并玩出花, 最快捷的方式是創(chuàng)建自己的開源項(xiàng)目, 長期維護(hù), 聚集人氣, 收獲志同道合的伙伴.

本文作者為zhaoolee, 交友主頁github.com/zhaoolee 目前做了幾個比較受歡迎的項(xiàng)目, 收獲3w老哥的star, 并維護(hù)至今; 也挖了很多坑, 最終不了了之, zhaoolee想通過本文, 為想要做開源項(xiàng)目的小伙伴提供一些經(jīng)驗(yàn)~

image

寫一份優(yōu)秀的README.md很重要

Github每個開源項(xiàng)目都有README.md文檔, 這個相當(dāng)于項(xiàng)目的首頁, 一定要寫好.

人類喜歡看圖, 為項(xiàng)目配一個漂亮的Logo或宣傳圖, 能體現(xiàn)開發(fā)者認(rèn)真的態(tài)度, 也能吸引老哥們多看幾眼, 有時候雖然你的項(xiàng)目很平凡, 但Logo很傳神, 也能讓大家為你鼓掌, 順便點(diǎn)個Star

image

image

在READMD.md中, 配gif圖是很有性價比的操作, gif圖可以默認(rèn)播放, 吸引瀏覽者的注意力, 并增加瀏覽者的駐留時間, 如果你PS/AE技術(shù)還不錯, 甚至魔改幾張表情包, 作為項(xiàng)目宣傳圖, 為項(xiàng)目增光添彩

image

最重要的內(nèi)容放到README.md最前面, 無論通過圖片還是文字, 都要讓人瞬間了解, 這是個什么類型的項(xiàng)目~

image

README.md沒有限制內(nèi)容的高度, 如果項(xiàng)目是Awesome類(收集集合類), 最好把主要內(nèi)容的目錄列到README.md中, 讓瀏覽者一觸即達(dá).

image

善用程序, 不要讓維護(hù)項(xiàng)目成為一件痛苦的事

我做過一個表情包項(xiàng)目 ChineseBQB, README.md寫的很騷, 還是中英雙語, 如果手工收集分類表情包并同步到主頁, 是一件非常痛苦的事.

于是我寫一個程序, 自動讀取特定目錄下的文件夾和文件名, 并自動生成網(wǎng)頁,并將網(wǎng)頁的索引自動更新到README.md, 還加了表情數(shù)量統(tǒng)計每次更新表情包只需往特定文件夾放圖即可, 放完圖后, 運(yùn)行腳本即可完成更新.

image

當(dāng)看到自己編寫的腳本, 生成索引, 并全自動完成索引替換, 表情包數(shù)量統(tǒng)計任務(wù)時, 成就感滿滿, 維護(hù)項(xiàng)目也成為了一件很爽的事...

建一個愛好者群, 可以提升維護(hù)項(xiàng)目的熱情

人的本質(zhì)是非常懶的, 維護(hù)個人開源項(xiàng)目, 需要耗費(fèi)時間精力, 如果到了項(xiàng)目到了不溫不火的階段, 就會沒有動力更新.

此刻, 不妨建一個企鵝群, 有人催更, 你自然也就有了更新的動力 , 當(dāng)群友們使用你開發(fā)的工具時, 你自然有了更新的熱情和動力!

image

比如奧特曼表情包https://www.v2fy.com/asset/0i/ChineseBQB/?key_val=%E5%A5%A5%E7%89%B9%E6%9B%BC

冰冰表情包 https://www.v2fy.com/asset/0i/ChineseBQB/?key_val=%E7%8E%8B%E5%86%B0%E5%86%B0

Github Pages和Github Actions都是好東西, 不嫖就虧了

Github Pages本質(zhì)是一個免費(fèi)無限流量的web托管服務(wù), 用戶可以往Github Pages托管靜態(tài)網(wǎng)頁, 流量無限, 空間無限, 且支持自定義域名.

Github Actions本質(zhì)是一個構(gòu)建服務(wù), 說穿了就是能在云端免費(fèi)為你運(yùn)行任意程序, 每個月2000分鐘, Github Actions使用非常靈活, 可以用于自動構(gòu)建項(xiàng)目, 比如給表情包生成網(wǎng)頁, 定時自動爬取優(yōu)質(zhì)博主的RSS源, 生成個人簡報, 定時自動爬取天氣, 規(guī)劃個人行程, Github Actions可以選擇運(yùn)行在Windows, Linux, macOS系統(tǒng), 如果玩的再騷一點(diǎn), 可以用來定時簽到領(lǐng)京豆, 領(lǐng)Epic游戲, 甚至挖礦(不推薦).

個人適合做什么類型的開源項(xiàng)目?

• Awesome(收集類) 這種最受歡迎, 但競爭也最為激烈(太卷了), 比如Windows軟件, 在線工具, Chrome插件, 表情包均可收集~

• 日常工具 工具要足夠?qū)嵱? 比如百度文庫爬蟲, 下載B站視頻, 批量下載特訂論壇的小姐姐圖片, 批量下載Bing壁紙~

• 編程工具庫 比如jQuery, Nodemail, PM2, http-server ...

• 編程框架 比如 Egg, Koa, Django...

如何推廣自己的開源項(xiàng)目?

Github的用戶主要是程序員, 推廣Github開源項(xiàng)目可以到程序員社區(qū).

v2ex.com

juejin.cn

csdn.net

或者阮一峰大佬的科技愛好者周刊投稿 github.com/ruanyf/weekly/issues

小結(jié)

Github的項(xiàng)目內(nèi)容在搜索引擎中有良好的SEO, 如果你是一名創(chuàng)作者, 白嫖Github Pages服務(wù)構(gòu)建自己的靜態(tài)網(wǎng)站, 會給你帶來持續(xù)的自然搜索流量, 如果你愿意掛Google Adsense廣告服務(wù), 還能空手套白狼, 賺一筆廣告費(fèi)(美刀), 只要你的內(nèi)容好, 搜索引擎算法和Github老哥們也會給你相應(yīng)的鼓勵和回報~

本文永久更新地址:

https://fangyuanxiaozhan.com/p/2021-04-27-17-11-56-program/