你在Git仓库上工作时,创建一个.gitignore文件告诉Git在提交更改时忽略哪些文件和目录是很重要的。这可以帮助保持仓库的干净并防止不必要的文件被提交。在这篇博客中,我们将介绍一些创建.gitignore文件的最佳实践,并提供一个推荐的.gitignore文件,供您作为起点使用。

1. 忽略生成的文件
许多编程语言和工具在构建过程中自动生成文件。这些文件不需要提交到您的Git仓库中,而且通常会非常大。生成的文件包括.class、.jar、.o和.pyc等。通过忽略生成的文件,您可以使您的仓库保持精简,并避免将不必要的文件弄乱。

2. 忽略敏感信息
避免将密码、API密钥和访问令牌等敏感信息存储在Git仓库中。如果您意外提交此类信息,它可能会被其他人看到,从而导致安全问题。要忽略的文件包括.key、.pem、.env和.config等。

3. 忽略用户特定文件
您应该避免提交特定于您本地环境或个人设置的文件。这些文件可能因用户而异,如果提交到仓库中可能会引起冲突。用户特定文件的示例包括.log、.swp、.DS_Store和Thumbs.db。

4. 忽略构建产物和输出
除了生成的文件之外,您还可以忽略构建产物和输出文件。这些文件通常是运行代码的结果,但在版本控制中跟踪它们并不必要。要忽略的文件和目录的示例包括/bin、/build、/dist和/target等。

5. 忽略第三方库和依赖项
如果您使用包管理器来管理依赖项,您应该避免将实际的包提交到您的Git仓库中。而是提交一个列出依赖项的文件,例如requirements.txt或package.json文件。要忽略的目录示例包括/node_modules、/vendor、/.venv和/.gradle等。

推荐的.gitignore文件
以下是一个推荐的.gitignore文件,它包括我们上面讨论的最佳实践:

# 忽略生成的文件
*.class
*.jar
*.o
*.pyc
*.dll

# 忽略敏感信息
*.key
*.pem
*.env
*.config

# 忽略用户特定文件
*.log
*.swp
*.DS_Store
Thumbs.db

# 忽略构建产物和输出
/bin
/build
/dist
/target

# 忽略第三方库和依

通过使用这个 .gitignore 文件,您可以确保您的 Git 仓库保持干净有序,并避免将不必要的文件提交到您的仓库中。

创建 .gitignore 文件
要创建 .gitignore 文件,您可以使用任何文本编辑器或代码编辑器。只需打开一个新文件,将我们提供的推荐 .gitignore 文件内容添加到其中,或根据您的需要进行自定义。

将文件保存为 .gitignore,并保存在您的仓库根目录下。

提交和推送 .gitignore 文件
一旦您创建了 .gitignore 文件,就需要将其提交和推送到您的 Github 仓库中。
 

git add .gitignore
git commit -m "Add ignore rule for files starting with dot"
git push 

您不需要将 .gitignore 文件推送到 Github,但如果您这样做,其他人就可以查看它,并按照与您相同的原则进行操作。

# 清楚缓存
git rm -r --cached .
# 在清楚跟踪文件缓存时 还需要手动添加要跟踪的文件

Logo

瓜分20万奖金 获得内推名额 丰厚实物奖励 易参与易上手

更多推荐