2015-08-27 25 views
2

我想開始將我的一些項目移至github回購站。我對如何組織這些回購協議中的文件感到有點不知所措。我想確保我做對了。我一直在研究的具體項目是我在Eclipse中構建的一個Java項目。它本質上是一種「引擎」,所以理想的結果是人們克隆存儲庫並將其構建爲使用引擎的自己的項目。如何在GIT上發佈java項目源文件?

這是我本地的項目結構。

src 
--com 
----myName 
------projectName 
test 
--com 
----myName 
------projectName 
bin 
config.properties 
README.md 
.gitignore 
.classpath 
.project 

我做的第一件事之一是gitignore在bin文件夾和所有類文件中的所有內容。

這並不是真的感覺像做'正確'的做事方式。我只是在猜測。我能遵守哪些標準慣例?

也讓我問一些具體的問題

  1. 是不是沒事了Java包創建很多(貌似多餘的)子文件夾?

  2. 忽略bin文件夾是否正確?或者如果其他人克隆它,這會使項目複雜化嗎?

  3. 我想說classpath和project文件夾也應該被忽略,但它們確實反映了文件中的變化。我是否認爲這些應該是可交換的文件?

  4. 我是否需要對組織進行任何特殊更改以反映這個特定項目是如何成爲我希望人們在自己的項目中克隆和使用的「引擎」?

我覺得這是一個簡單的概念,我可能已經過去複雜,但我要確保這是做正確的第一次。任何人都可以指示我關於git repo組織的資源將不勝感激!

在此先感謝。

+0

我建議,爲了避免在Java代碼中使用泛型混淆你的絲毫不差的變化。 – Victor

回答

0

要什麼我對事物的認識,你可以做兩件事情:

分享您的來源爲Java庫包裹在一個jar文件。你可以避免所有這些「我怎麼分享」的問題。

或者您可以在GIT等軟件版本工具中共享該項目。理想情況下,您將不得不向客戶提供兩件事:代碼和一種輕鬆設置編碼環境的方法。

在你的情況

共享代碼:該代碼是Java源下正在src和測試文件夾。

允許其他人快速設置他們的工作環境:讓我們看看,您正在使用使用Eclipse的構建系統,因此您應該學習如何從其他機器共享eclipse項目。我可以提前告訴你的是...我不需要bin文件夾(2)。但是.classpath和.project是。這對於在eclipse IDE中打開項目是必須的.​​.....問題在於您的IDE可能具有某些特定的庫或類路徑配置,而其他Eclipse不會出現並且可能會出現問題(3)。

我的建議是採用獨立的IDE建設者分享您的項目。行家一樣,例如。是的..你總是依賴於東西..只是更重要的是更容易的問題,人類已經證明的東西像行家更容易。

關於問題(1),不壞,只要它具有意義。

和(4)我想不會。