Visual Studio プロジェクトの .gitignore 完全ガイド

— GitHub公式テンプレを“現場目線”で読み解く

TL;DR

  • 目的は「再生成できるもの／個人環境のゴミ」をGit管理から外すこと。
  • すでに追跡中のファイルは .gitignore を追加しても無視されない → git rm –cached で追跡解除。
  • 迷ったら git check-ignore -v <path> で どのルールに当たったか を確認。
  • Unity と併用する場合は Unity専用の無視項目（Library/, Temp/ など） も追加し、Assets/** と *.meta は追跡する。

1) .gitignore の基本（30秒で要点）

  • Gitは“未追跡ファイルの追加”を止めるだけ。追跡済みのものには影響しません。
  • パターン構文の要点：
    • *（任意）、?（1文字）、[]（文字クラス）、行頭 !（例外再包含）、末尾 /（ディレクトリ指定）
    • スペースを含むパスは Generated\ Files/ のように バックスラッシュでエスケープ

2) テンプレの重要ブロックを素早く把握

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore

# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates

# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs

# Mono auto generated files
mono_crash.*

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/

# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/

# Visual Studio 2017 auto generated files
Generated\ Files/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c

# Benchmark Results
BenchmarkDotNet.Artifacts/

# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/

# ASP.NET Scaffolding
ScaffoldingReadMe.txt

# StyleCop
StyleCopReport.xml

# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
# but not Directory.Build.rsp, as it configures directory-level build defaults
!Directory.Build.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb

# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap

# Visual Studio Trace Files
*.e2e

# TFS 2012 Local Workspace
$tf/

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json

# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info

# Visual Studio code coverage results
*.coverage
*.coveragexml

# NCrunch
_NCrunch_*
.NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*

# MightyMoose
*.mm.*
AutoTest.Net/

# Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj

# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/

# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets

# Microsoft Azure Build Output
csx/
*.build.csdef

# Microsoft Azure Emulator
ecf/
rcf/

# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload

# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/

# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs

# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk

# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak

# SQL Server files
*.mdf
*.ldf
*.ndf

# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl

# Microsoft Fakes
FakesAssemblies/

# GhostDoc plugin setting file
*.GhostDoc.xml

# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/

# Visual Studio 6 build log
*.plg

# Visual Studio 6 workspace options file
*.opt

# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw

# Visual Studio 6 auto-generated project file (contains which files were open etc.)
*.vbp

# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp

# Visual Studio 6 technical files
*.ncb
*.aps

# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions

# Paket dependency manager
.paket/paket.exe
paket-files/

# FAKE - F# Make
.fake/

# CodeRush personal settings
.cr/personal

# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc

# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config

# Tabs Studio
*.tss

# Telerik's JustMock configuration file
*.jmconfig

# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs

# OpenCover UI analysis results
OpenCover/

# Azure Stream Analytics local run output
ASALocalRun/

# MSBuild Binary and Structured Log
*.binlog

# NVidia Nsight GPU debugger configuration file
*.nvuser

# MFractors (Xamarin productivity tool) working folder
.mfractor/

# Local History for Visual Studio
.localhistory/

# Visual Studio History (VSHistory) files
.vshistory/

# BeatPulse healthcheck temp database
healthchecksdb

# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/

# Ionide (cross platform F# VS Code tools) working folder
.ionide/

# Fody - auto-generated XML schema
FodyWeavers.xsd

# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp

# JetBrains Rider
*.sln.iml

ユーザー/IDE固有

  • *.suo, *.user, .rsuser, .sln.docstates, *.userprefs→ 開発者ごとの環境差分。共有無用。

ビルド成果物・中間生成

  • [Dd]ebug/, [Rr]elease/, [Bb]in/, [Oo]bj/, x64/, x86/, ARM/, ARM64/, Logs/→ 再生成できるので管理不要。差分を汚さない。

Visual Studio キャッシュ/生成

  • .vs/, Generated\ Files/→ VSが作るローカル作業キャッシュ。無視でOK。

テスト・カバレッジ

  • TestResult*, *.VisualState.xml, *.coverage*, coverage*.{json,xml,info}→ ローカル実行結果。履歴に不要。

C/C++/VC++ 系中間物

  • *.ipch, *.opendb, *.VC.db ほか→ インデックス・中間ファイル。

デプロイ/配布・クラウド関連

  • ClickOnce publish/、Web Publish（*.pubxml, *.publishproj）、Azure（PublishScripts/, csx/, *.build.csdef など）→ 機密混入の恐れ。原則無視。

NuGet

  • **/[Pp]ackages/*（ただし !**/[Pp]ackages/build/ は例外）→ 依存は復元が前提。build/ 配下のMSBuildターゲットだけは必要になることがあるので許可。

VS Code / Node / Python

  • .vscode/* ただし settings.json, tasks.json, launch.json, extensions.json は共有可
  • node_modules/, __pycache__/, *.pyc→ 復元可能な依存・生成物は無視。

インストーラ/ログ/その他

  • *.msi, *.msix, *.cab, *.binlog など→ 出力物・巨大ファイルは追跡不要。

例外（再包含）の代表：

  • !Directory.Build.rsp … 既定のビルド応答をチームで共有したい需要への配慮
  • !**/[Pp]ackages/build/ … ビルドに必要なターゲットを温存
  • .vscode/* 無視しつつ 4つのJSON は共有OK（チーム設定だけ共有）

3) よくある“現場カスタマイズ”の指針

  • wwwroot/（ASP.NET Core）
    • ビルドで生成するなら無視のまま。静的資産を手管理するなら無視を外して追跡。
  • *.pubxml（Publishプロファイル）
    • 原則無視。秘匿が徹底できる運用（接続文字列をSecret/変数化など）なら追跡してもよい。
  • テスト成果物・カバレッジ
    • 履歴に残したいときは 出力先を artifacts/ に寄せ、.gitignore は維持。成果物はCIで収集。
  • ログ/診断
    • 解析に使うが履歴不要 → .gitignore で無視し、必要時は添付やArtifactsでやり取り。

4) Unity と併用する場合（超重要）

Visual Studioテンプレ だけ ではUnityの巨大生成物を拾ってしまいます。追加で Unity向けを入れてください。

# Unity 追加推奨
[Ll]ibrary/
[Tt]emp/
[Oo]bj/
[Bb]uild*/
[Bb]uilds/
[Ll]ogs/
[Mm]emoryCaptures/
UserSettings/
# アセットは追跡、.meta は必ず必要
#（Assets/ を ignore しない、 *.meta を ignore しない）
  • なぜ .meta が必要？UnityはGUIDで参照関係を管理。.meta を落とすとリンク切れ・プレハブ破損が起きます。
  • 誤設定あるある
    • Assets/ まるごと無視 → そもそもプロジェクトが空っぽに。
    • *.meta を無視 → 参照崩壊。絶対NG。

5) 運用Tips（小さく効くやつ）

  • 最初に入れる：リポジトリ作成直後に .gitignore をコミット。
  • 追跡解除：すでに誤って入れたものは「キャッシュから外す」
git rm -r --cached Bin/ Obj/ .vs/ # 例
git commit -m "Remove build artifacts from tracking"
  • ルール確認：
git check-ignore -v path/to/file
  • 一時的に入れる（強制追加）：
git add -f path/to/ignored.file
  • ローカルだけ変更を無視（応急/自己責任）：
git update-index --assume-unchanged path/to/file
# 取り消し
git update-index --no-assume-unchanged path/to/file

6) ミニマム版サンプル（VS + Unity向け）

（最初の雛形にどうぞ。用途に応じて追加）

# --- Visual Studio ---
.vs/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
*.user
*.suo
*.rsuser
*.sln.docstates
*.ipch
*.VC.db
*.opendb
*.cache
*.tlog
*.pdb
*.ilk
*.log
*.binlog
# 例外：ディレクトリビルド設定は共有
!Directory.Build.rsp

# NuGet
**/[Pp]ackages/*
!**/[Pp]ackages/build/
*.nupkg
*.snupkg

# VS Code（チーム設定のみ共有）
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# --- Unity ---
[Ll]ibrary/
[Tt]emp/
[Oo]bj/
[Bb]uild*/
[Bb]uilds/
[Ll]ogs/
UserSettings/
# Assets と *.meta は追跡（= ここで無視しない）

7) FAQ（よくある疑問）

Q. *.rsp は無視なのに !Directory.Build.rsp を許可するのはなぜ？

A. ディレクトリ単位のビルド既定をチームで共有するため。VSの一時的な .rsp は無視でOK。

Q. packages/ は無視なのに packages/build/ を残すのは？

A. 一部プロジェクトは build/ 配下の props/targets を参照してビルド定義を補います。ここを落とすとビルドが壊れることがあるため。

Q. もう追跡してしまった Bin/ や .vs/ を今から消したい

A. 追跡解除（git rm -r –cached <dir>）→コミット→クリーンビルド。作業中の変更は退避しておくと安全。

8) 導入チェックリスト

  • .gitignore を最初に追加・コミットした
  • VSのキャッシュ・ビルド成果物を除外できている
  • Unity 併用時は Library/ 等を必ず除外、Assets/** と *.meta は追跡
  • 秘匿情報（接続文字列・Publish設定など）が入っていない
  • CI で復元・ビルド・テスト・成果物収集の流れが確立している

まとめ

GitHub公式テンプレは VS系の“捨てるべきもの”を幅広くカバーしつつ、! の例外で「共有すべき最小限の設定」を残す設計です。プロジェクトの性質（ASP.NET/WinForms/Unity/ツール群）に応じて、上記の“現場カスタマイズ”を少し足せば、差分が澄んだ、再現性の高いリポジトリ運用が実現できます。

訪問数 6 回, 今日の訪問数 6回

Git,バージョン管理,便利機能

Posted by hidepon