讓第一次造訪儲存庫就有收穫
分享連結之前,以從未聽過此專案的人的角度開啟儲存庫。第一個畫面應說明要解決的問題、適用對象,以及最快看到成果的方法。視覺化工具可以用螢幕截圖輔助說明;對函式庫來說,小型輸入/輸出範例通常更有幫助。
以假想的 CSV 驗證工具為例,「將 CSV 匯出檔匯入資料庫前先進行驗證」比「強大的資料工具組」更具體。接著提供一份含錯誤的範例檔案、檢查它的指令,以及產生的錯誤訊息。
- 把用途和可運作的範例放在冗長的功能清單之前。
- 說明執行環境需求、安裝步驟及已知限制。
- 提供授權條款、文件及回報問題管道的連結。
- 使用準確的儲存庫主題標籤,讓瀏覽該主題的人找到你的專案。
找到第一批相關讀者
選擇已有人討論你所解決問題的社群。Python 資料工具與瀏覽器設計工具需要不同的介紹方式。說明一個具體使用情境,以及你想收到哪方面的回饋。表明自己是專案維護者,並先閱讀社群發文規則。
初次嘗試保持小規模:改善 README,在一個合適的地方分享一個能執行的範例,並回答隨之而來的問題。如果讀者無法安裝,先解決這點再增加管道。反覆張貼相同連結,無法取代改善上手流程。
提供實用價值後再邀請加星標
在快速開始後加上一句可自由選擇的邀請就夠了:「如果這個專案對你有幫助,可以為儲存庫加上星標,方便日後找到。」無論讀者是否加星標,都應提供安裝說明、文件及支援。
GitHubStart 提供公開的專案探索與交流目錄。你不必登入 GitHubStart,就能登錄公開儲存庫、瀏覽其他專案,並決定想支持哪些專案。加星標仍須登入 GitHub 後手動操作。登錄儲存庫並不保證獲得特定數量的星標或對方回贈星標。
每週記錄學到的事
記下日期、所做變更、分享地點、收到的問題及完成的修正。將星標與成功安裝、可重現的問題及持續貢獻等實際指標一起比較。發文後星標激增只是相關性,不能證明每個新星標都來自該篇貼文。
例如:如果有五位讀者詢問如何設定權杖,就把設定說明移到範例前面。將修正後的範例分享給這些讀者,而不是再發布一篇泛泛的上線公告。
- 第 1 週:在乾淨的環境中驗證快速開始步驟。
- 第 2 週:分享一個使用情境並回覆意見。
- 第 3 週:發布修正並說明變更內容。
- 第 4 週:保留帶來有用對話的管道,並重新檢視其他管道。
常見問題
如何獲得最初的 100 個 GitHub 星標?
把 100 當成里程碑,而非保證的成果。從可用的專案、清楚的 README 及相關讀者開始。無論目前有 5 或 500 個星標,都適用相同方法;所需時間取決於受眾與專案。
可以不登入就為 GitHub 儲存庫加星標嗎?
你不需要網站帳號就能瀏覽公開儲存庫及 GitHubStart。若要加星標,必須自行登入 GitHub。GitHubStart 不會代你執行此操作。
星標越多,使用者就越多嗎?
不一定。有些人可能只是收藏儲存庫以備日後使用,並未安裝。請將實際採用情況與回饋,和星標數量分開追蹤。