“.gitignore”文件中应该忽略哪些项目文件?

时间:2017-06-20 15:31:50

标签: git maven github spring-boot repository

我已经创建了我的第一个git存储库并尝试放置Spring Boot项目。

在最初的git中要求配置“.gitignore”文件,但我不确定哪些文件必须(应该),所以我忽略了?

在我的第一次提交推送中,我看到了几个文件APART FROM pom.xml和我的一些.java文件,如

.classpath
.gitignore
.project
.settings/org.eclipse.core.resources.prefs
.settings/org.eclipse.jdt.core.prefs
.settings/org.eclipse.m2e.core.prefs

我不确定他们为什么在这里? 他们应该在那里吗?

如何以及在何处创建.gitignore文件?

3 个答案:

答案 0 :(得分:6)

查看https://www.gitignore.io/ 在那里,您可以根据您使用的内容创建推荐的gitignore。

对于Eclipse,它说:

# Created by https://www.gitignore.io/api/eclipse

### Eclipse ###

.metadata
bin/
tmp/
*.tmp
*.bak
*.swp
*~.nib
local.properties
.settings/
.loadpath
.recommenders

# External tool builders
.externalToolBuilders/

# Locally stored "Eclipse launch configurations"
*.launch

# PyDev specific (Python IDE for Eclipse)
*.pydevproject

# CDT-specific (C/C++ Development Tooling)
.cproject

# Java annotation processor (APT)
.factorypath

# PDT-specific (PHP Development Tools)
.buildpath

# sbteclipse plugin
.target

# Tern plugin
.tern-project

# TeXlipse plugin
.texlipse

# STS (Spring Tool Suite)
.springBeans

# Code Recommenders
.recommenders/

# Scala IDE specific (Scala & Java development for Eclipse)
.cache-main
.scala_dependencies
.worksheet

### Eclipse Patch ###
# Eclipse Core      
.project

# JDT-specific (Eclipse Java Development Tools)     
.classpath

# End of https://www.gitignore.io/api/eclipse

我在团队中有很多讨论是否将基于IDE的文件放在GIT中。有些人喜欢它,有人说每个开发人员都知道如何根据pom.xml为项目配置他们的IDE。

我现在的意见是,远离VCS中的所有IDE文件。

答案 1 :(得分:3)

Eclipse IDE使用.classpath文件,.project文件和.settings/目录。

关于将特定于IDE的项目文件置于源代码管理之下,有不同的意见。我更喜欢将它们排除(并让IDE从pom生成项目文件,前提是它具有不错的Maven集成 - 这是eclipse所做的),因为我已经看到它们分享它们导致的问题比它解决的更多。其他人可能会告诉你他们都应该被包括在内,我会留给他们证明他们的理由;关键是,我不相信对此有一个明确的共识。

.gitignore文件包含忽略规则。它特别包含要通过存储库共享的规则,因此包含在内。 (如果您忽略了意味着通过存储库共享的规则,则还有其他文件可以定义这些规则;请参阅git ignore docs。)

答案 2 :(得分:0)

当您使用任何IDE开发应用程序时,它们通常会生成一组额外的文件,用于保存项目设置。将这些设置上传到git,svn等版本控制工具被认为是不好的做法,因为这些配置特定于每个开发人员的开发环境,在某些情况下,它可能会阻止项目在IDE中正常打开,因为它试图寻找不在PC上的资源,因此建议不要上传这些配置。

如何避免上传IDE的配置?

Git为我们提供了.gitignore文件,我们可以在其中设置我们要忽略的所有文件。只需在主项目文件夹中创建.gitignore文件,例如~/workspace/my-project/,使用任何文本编辑器(甚至在IDE中)打开该文件,然后添加要忽略的文件。

正如@Michael所说,你可以在你正在使用的IDE的基础上生成一组要忽略的文件,看看这个link,例如eclipse (点击{{3} }生成)将配置复制并粘贴到.gitignore文件中。

如果您已将这些配置上传到存储库,则必须将其删除以使新的gitignore配置生效,请查看这些链接hererevert changes in git