1.什么是.idea文件夹
因为IntelliJ IDEA是JetBrains最早推出的IDE(JetBrains一开始叫IntelliJ),因此使用IDEA作为配置文件夹的名称。按照这个SO问题里最高票答案的猜测,或许IntelliJ IDEA这个名字的含义是这样组成的:
-
Intelli ===> Intelligent
-
J ===> Java
-
Idea ===>IDE that is Advanced or Idea just means idea( I have a good idea ...like this ) ...
2.是否应该把.idea提交进Git仓库
如果你想让其他使用相同IDE的用户可以更方便或规范的对项目进行开发,那么就把它提交到Git仓库中。比如,你可以设置文件模板(.idea/fileTemplates),定义代码风格(.idea/codeStyleSettings.xml),定义检查器(.idea/inspectionProfiles/),这样其他开发成员可以很方便的上手项目,这会比写在“贡献指南”约束性强一些。
如果你觉得Git仓库不应该包含和项目本身无关的文件,那么也可以不将它提交到Git仓库中。
3.正确的提交方法
当然,将.idea目录整个提交到Git仓库的行为并不可取。因为.idea目录下的文件中有包含隐私的内容(比如你的文件操作变动、用户词典、系统环境变量、数据库密码等等),或是临时生成的文件,这些文件对项目其他的参与者没有用处,而且会泄露你的隐私或是影响正常开发。
如果你选择将.idea目录提交仅Git仓库,那么需要稍微多付出一些工作。
按照JetBrains官方的建议,在使用VCS时提交.idea文件夹应该遵循下面的原则:
1. 分享下面的文件:
除了workspace.xml、usage.statistics.xml和tasks.xml以外.idea目录下的所有文件 所有可以被在不同模块目录下定位到的.iml模块文件(适用于IntelliJ IDEA)
2. 谨慎分享下面的文件:
Android artifacts that produce a signed build,因为它们包含keystore密码(前半句不理解,暂时保留原文)
在IntelliJ IDEA 13 和之前的版本中的dataSources.ids和datasources.xml文件,它们包含数据库密码
3. 避免分享下面的文件:
对于使用Gradle或Maven的项目,避免分享.iml和.idea/modules.xml文件,因为它们会在导入时生成gradle.xml文件
用户字典(dictionaries文件夹)
.idea/libraries目录下的XML文件,因为它们会从Gradle或Maven项目中生成
推荐提交
-
.idea/vcs.xml
-
.idea/fileTemplates/
-
.idea/inspectionProfiles/
-
.idea/scopes/
-
.idea/codeStyleSettings.xml
-
.idea/encodings.xml
-
.idea/copyright/
-
.idea/compiler.xml
总结
如果你不想在Git仓库中提交IDE相关的配置文件,那么你可以忽略.idea文件夹;相反,你也可以有选择的把.idea目录下的文件提交进Git仓库。也就是说,项目Git仓库中是否包含.idea文件夹与程序员的开发水平并没有直接关系。我感觉不提交还是对的。