使用PyCharm和Git时，我应该忽略.idea文件夹吗？

Question

我在PyCharm中读到了Git集成，并从PyCharm创建了一个Git存储库。我在PyCharm中这样做是因为我希望PyCharm知道是否应该忽略.idea文件夹，如果是这样的话，它会自动创建一个.gitignore文件，其中包含.idea/行。 1}}在里面。

但它没有，所以我认为我不应该忽视.idea。但是，我进行了快速搜索，找到了某个例子.gitignore文件，here，它明显忽略了.idea文件夹。

所以，我的问题是，是否应该忽略.idea文件夹？

Answer 1

忽略整个.idea文件夹不一定是最好的主意。这里有很多类似的讨论。

• How to deal with IntelliJ IDEA project files under Git source control constantly changing?
• Intellij Idea 9/10, what folders to check into (or not check into) source control?
• Should the .idea folder be kept under source control?

但我建议在此问题上查看official FAQ。

Answer 2

  

.idea目录中的所有设置文件都应放在   版本控制除了workspace.xml，它存储您的本地   喜好。 workspace.xml文件应为marked as ignored by VCS。

     

- PyCharm 2017.3 project documentation

为了进一步说明，workspace.xml包含特定于用户的工作区首选项。这包括environment variables，最近访问过的文件和光标位置。

Answer 3

我建议在共享项目时忽略.idea文件夹，，尽管PyCharm's documentation建议使用。

虽然分享您的项目设置不是本身一个坏主意，但您应该注意一些例外和潜在问题。

• workspace.xml文件包含各种特定于用户的设置，例如环境变量，光标位置和Python SDK位置。
  • 环境变量可能包含私人数据，例如用户名和密码
• dictionaries文件夹包含自定义拼写，如果两个开发人员具有相同名称，则会导致冲突。
• .idea文件夹特定于PyCharm，这意味着使用不同IDE的开发人员可能导致项目失步。
• IntelliJ's own documentation包含几个不应共享的特定文件的警告。

如果您 决定分享.idea，IntelliJ's official documentation会提供以下建议

  默认情况下，所有最新的IDE版本都使用

[.idea]格式。   以下是您需要分享的内容：

     

  
• 项目根目录中 .idea 目录下的所有文件， workspace.xml 和 tasks.xml 存储用户特定设置的文件
  
• 可以位于不同模块目录中的所有 .iml 模块文件（适用于IntelliJ IDEA）
  

     

小心关于分享以下内容：

     

  
• 产生签名版本（将包含密钥库密码）
的Android工件   
• 在IDEA 13及更早版本的 dataSources.ids 中， datasources.xml 可以包含数据库密码。 IDEA 14 solves this problem。
  

     

您可以考虑不要分享以下内容：

     

  基于 Gradle 或 Maven 项目的
• .iml 文件，因为这些文件将在导入时生成
  
• gradle.xml 文件，see this discussion
  
• 用户词典文件夹（以避免在其他开发者具有相同名称时发生冲突）
  
• .idea / libraries 下的XML文件，以防从Gradle或Maven生成项目
  

     

来源：JetBrains - How to manage projects under Version Control Systems

Answer 4

.idea /文件夹就是JetBrain存储数据的方式。它在IntelliJ和PyCharm中，所以，是的，它可以被忽略。