git目录应该在IntelliJ IDEA文件层次结构中的什么位置?

时间:2019-04-04 12:12:50

标签: java git intellij-idea

我正在学习Java,并使用JetBrains的IntelliJ IDEA作为IDE。我正在做一个小项目,我想通过git / GitHub进行跟踪,同时我也在学习如何使用它。

我的问题是:我应该将git目录放在哪里(即.git文件夹应该放在哪里)?

您可能已经知道,创建项目时IntelliJ会自动创建以下文件夹结构:

  • .idea由IntelliJ创建的文件夹
  • out文件夹,其中包含已编译的类
  • src文件夹,其中包含源代码(.java文件)
  • projectName.iml由IntelliJ创建的文件

我在将其放置在项目的根文件夹或src文件夹之间犹豫不决。我的直觉会促使后者前进,因为这是我最想分享的内容,但我想知道最佳做法是什么。

2 个答案:

答案 0 :(得分:0)

通常,您实际上应该将其保留在根文件夹中,并只需创建.gitignore,其中包含所有您不想放入回购中的文件夹。

这是因为出于实际原因,您确实希望您的根文件夹成为git存储库。如果将其保留在src文件夹中,则基本上可以省去根文件夹中的所有内容,例如pom.xmlbuild.gradle或其他文件。而且,由于大多数IDE实际上使用带有src/mainsrc/test文件夹的格式,因此会使其他人更难以使用该项目。

答案 1 :(得分:0)

最佳实践是将根目录放入git并在.gitignore文件中列出所有不想推送到git的内容。您可以使用开源Java项目作为示例,例如https://github.com/apache/jmeter 您可以看到.gitignore内容:https://github.com/apache/jmeter/blob/trunk/.gitignore