2017-01-10 32 views
2

我對GitHub相當陌生,並且被我以前從未見過的所有文件和文件夾以及文件擴展名所困惑。大多數存儲庫中的所有文件和目錄是什麼意思?

在倉庫只是考慮看看,我看到比如這個:

  • [文件夾] DIST
  • [文件夾] SRC
  • [文件夾]測試
  • [文件]封裝。 JSON
  • [FILE] gulpfile.js
  • [FILE] bower.json

這些只是我看到的一些文件和文件夾。這一切做什麼?如果我想分發自己的代碼,是否需要使用某種預製結構?每個人似乎都這樣做,如果我不像這樣構建我的回購協議會發生什麼?

有沒有我錯過的任何會議指南/風格指南?

回答

1

目錄和文件結構是不同爲每個編程語言和編譯系統。通常情況下,人們遵循這些約定:

  • dist/:分佈,通常包含編譯軟件(包括縮小的代碼)
  • src/:源,包含軟件
  • build/的源文件:包含代碼未被縮小並且未準備好用於生產
  • test/:包含存儲庫的測試文件
  • package.json:描述th或E封裝(在JavaScript/NPM)
  • gulpfile.js:文件充當體現在程序定義任務
  • bower.json:用於定義鮑爾包,以便您可以創建自己的包,它包含了所有的相關性你的軟件

你可以找到更多關於造型約定herehere

編輯:你可以查看特定語言的項目結構。例如,this可能對Node.js項目有幫助。

+0

您好!感謝你的回答。有沒有關於HTML,PHP,JavaScript的任何約定,我可以嘗試遵循?這些是我會做項目的三種主要語言。 如果我爲WordPress或任何其他CMS製作插件,那麼我是否也應該遵循一個慣例,或者當它更具體的存儲庫時它更放鬆? 我的主要擔心是創建一個回購,其他人無法使用,因爲我沒有遵循某種約定或類似的規則。儘管這可能只是一種非真實的恐懼。 謝謝。 – user7396671

+0

您不應該擔心人們無法使用您的存儲庫。如果你真的想虔誠地遵循慣例,你可以使用[Google的JavaScript風格指南](https://google.github.io/styleguide/javascriptguide.xml)。我建議查看已知的JavaScript/PHP/HTML/Wordpress插件庫,並嘗試模仿他們的項目結構。 – kkmonlee

相關問題