PyCharm和源代码控制，.idea目录，提交还是不提交，这是个问题

Posted 2023-03-28

【中文标题】PyCharm和源代码控制，.idea目录，提交还是不提交，这是个问题

【英文标题】：PyCharm and source control, the .idea directory, commit or not commit, that is the question

【发布时间】：2011-06-29 16:39:22

【问题描述】：

我开始了一个新的PyCharm 项目并希望使用Mercurial 对其进行版本控制。

项目目录中有一个 .idea 目录，其中包含以下文件（以及我是否对它们进行版本化的假设）

.name - 包含项目的名称（版本：

yes

） encodings.xml - 包含文本文件编码的默认值（？）（版本：

yes

） misc.xml - 包含有关组件的信息，以及要使用的 Python 可执行文件（版本：

no

- 因为它硬编码了 python.exe 的路径） modules.xml - 包含模块列表，其中包含项目名称（版本：

yes

） ProjectName.iml（版本：

是

） vcs.xml - 指定使用哪个 VCS（版本：

yes

workspace.xml - 似乎列出了 PyCharm 窗口的布局信息（版本：

no

）

我的假设正确吗？

【参考方案1】：

除了workspace.xml 之外的所有文件都应该共享，see the FAQ。

【讨论】：

FAQ还建议你忽略tasks.xml

基于更新后的KB article，您不妨也忽略gradle.xml和用户dictionaries

【参考方案2】：

取决于您是想仅共享代码还是共享代码和项目设置。

为了共享代码，我将以下内容添加到 .hgignore 文件中：

^.idea
^.idea/*
/*/.idea
/*/.idea/*

这些模式有点矫枉过正，但它们消除了所有 PyCharm/Workspace 的东西。

我们主要在我工作的地方使用 Subversion，并且我经常在 Subversion 结帐之上创建一个 Mercurial 存储库，以进行可能的调整和更改。如果你走这条路，特别是如果你链接 Mercurial 存储库，那么也将这些条目添加到 .hgignore 文件中：

^.svn
^.svn/*
/*/.svn
/*/.svn/*