.gitignore 文件在 Git 版本控制系统中起着关键作用。它的主要目的是列出不应该被 Git 跟踪和提交的文件或目录模式。这有助于排除那些可能包含敏感数据、大型二进制文件、临时编译产物或其他不希望纳入版本控制系统的文件。
当你创建一个新的 Git 存储库或在现有存储库中工作时,有一些文件通常是不需要跟踪的,例如:
- 编译后的二进制文件或中间产物,如 .class 文件(Java)、.pyc 文件(Python)等。
- 自动生成的文件,如 IDE 的缓存文件、日志文件、数据库文件等。
- 用户特定的配置文件,如 .env 文件,其中可能包含 API 密钥和其他秘密。
- 大型媒体文件,如图像、视频,这些通常不适合放在版本控制系统中。
.gitignore 文件中的每一行代表一个要忽略的模式。例如,假设你正在管理一个 Python 项目,你可能会有以下 .gitignore 内容:
# Ignore compiled Python files
*.pyc
# Ignore virtual environment directory
venv/
# Ignore log files
logs/*.log
# Ignore user-specific configuration file
.env
当你在 Git 中初始化仓库后,任何符合上述模式的文件都不会被添加到索引中,因此也不会被提交到仓库历史记录中。这有助于保持仓库的整洁,减少不必要的文件传输,并保护敏感信息不被意外泄露。
总之,.gitignore 文件是维护干净、安全和高效的 Git 存储库的重要组成部分。
常用团队配置
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
node_modules
dist
dist-ssr
*.local
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?