2016-12-20 69 views
2

我是新來的開發,並試圖上傳我已經工作到我的GitHub配置文件的小項目。這些項目不相互依賴。如何在GitHub中組織和分類小型項目?

我的問題是,他們中的一些是小型單文件項目。有點像我已經解決的迷你挑戰。因此,我正在考慮將它們組合在一個名爲「Python編程」的回購站中,例如。

這是一個很好的做法嗎?

  • 如果是的話,我應該怎麼去了解它的Git,和 我怎麼能仍然顯示爲每個小項目的README文件。

  • 如果不是,您會推薦做什麼?

+1

回購可以是任何東西,你需要它,您個人使用。將它們分成文件夾,每個文件夾都提供了自述文件(例如,您可以將它們與Gulp合併)。團隊或合作者可以將其轉變爲與他們的偏好相對應的東西。那裏沒有硬性規定。 – Nevertheless

回答

2

GitHub將爲您訪問的每個文件夾呈現一個README文件,因此,當僅使用一個存儲庫時,一種解決方案是仍然爲每個「子項目」創建一個子文件夾,因爲它們可以有自己的README文件。

但在此之前走這樣一條路,你應該想想,如果這些小項目實際上屬於一起。最終,應該決定是將所有內容都放在同一個存儲庫中,還是要將其分割爲多個存儲庫。

有些事情要考慮這一決定:

  • 如果項目不依賴於其他,是否還涉及另一個?例如,這些項目是Project Euler這樣的更大規模編程挑戰的一部分,您只是在收集所有解決方案?那麼單個存儲庫可能更有意義。
  • 個別項目成長爲更大的事物的機會是多少?許多事情開始很小,但最終可以成長爲真正的東西,證明自己的存儲庫。那時,你甚至可能會讓別人做出貢獻。
  • 這些文件能夠共享歷史記錄嗎?這些文件在「完成」後甚至會被編輯?即這只是一個完成的東西的集合,還是他們實際上正在進行的實驗?

最終,它歸結爲個人的選擇。但是,GitHub作爲存儲庫託管服務器,不應該推動您的決定。您應該在本地創建Git存儲庫,因爲它對您有意義。如果這意味着你只有一個,那很好。如果這意味着你創造了很多,那也很好。

不幸的是,GitHub的UI是不是真的對小型一次性項目取得。存儲庫列表只是爲了組織而已。如果你決定使用小型項目,我建議你在你的GitHub配置文件中添加一些用於分類的前綴,這樣你就知道這是關於什麼的。

一個很好的選擇爲一次性項目,尤其是當它只是一個(或幾個)文件Gists。 Gist是作爲共享代碼片段的一種方式而誕生的,但是每個Gist實際上都是一個完整的Git存儲庫。當然,Gist不提供GitHub上的常用工具庫(例如問題,拉取請求,維基)。但對於你所描述的,你可能不需要那些。然後,Gist是一種很好的方式來分享簡單的東西,而無需將完整的存儲庫添加到您的配置文件。而且你還可以克隆它們(遠程URL是[email protected]:/<gist-id>.git),並有充分的歷史和多個文件的支持,如果你需要的。

+0

我是一名機械工程師,一年前決定自學軟件開發。現在我正在尋找工作,我的朋友們建議我將所有項目都放在GitHub上作爲一個投資組合。因此,組織較小項目的頭痛。 但你的回答給了我很多的清晰。乾杯! –

2

通常情況下,你會看到,回購的頂級中包含的README文件,也許setup.py和其他一些無關緊要的信息,也許tests文件夾。然後會有一個與repo共享名稱的文件夾。該文件夾的內部是旨在成爲模塊/包/腳本的核心內容的代碼。

這也是很平常看到不同的組織,特別是單文件的腳本非常小的項目。

對於您提到的具體情況,請做任何您喜歡的事情。你的建議聽起來對我來說完全合理。我不想爲我解決的所有挑戰有單獨的回購協議!

我通常使用一個gist爲了微不足道的項目我並不想爲回購協議,其中包括編碼的挑戰。所以我會提供這個選擇。做任何你最適合的事情。