From f3c5b00932a157afbbed8610aaf601ccec493549 Mon Sep 17 00:00:00 2001
From: Martin Hauser <mhauser@netboxlabs.com>
Date: Tue, 5 May 2026 18:25:06 +0200
Subject: [PATCH] Closes #22056: Clean up obsolete .gitignore entries and add
 comments (#22116)

---
 .gitignore | 68 +++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 49 insertions(+), 19 deletions(-)

diff --git a/.gitignore b/.gitignore
index ea2ce9512..71d517354 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,33 +1,63 @@
-*.pyc
-*.swp
-npm-debug.log*
+# Python bytecode, cache directories, and test coverage output
+__pycache__/
+*.py[cod]
+.coverage
+
+# Python virtual environment created by the installation/upgrade workflow
+/venv/
+
+# Frontend dependencies and Yarn logs generated during asset development/builds
+/netbox/project-static/node_modules/
 yarn-debug.log*
 yarn-error.log*
-/netbox/project-static/node_modules
-/netbox/project-static/docs/*
-!/netbox/project-static/docs/.info
+
+# Documentation generated by the upgrade/build workflow
+/netbox/project-static/docs/
+
+# Static files collected by Django
+/netbox/static/
+
+# Local NetBox configuration files created or copied during installation
 /netbox/netbox/configuration.py
 /netbox/netbox/ldap_config.py
-/netbox/local/*
+/local_requirements.txt
+
+# Local settings overrides loaded by settings.py if present
+/netbox/netbox/local_settings.py
+
+# Deployment-local files under the optional local directory
+/netbox/local/
+
+# User-uploaded media files; MEDIA_ROOT defaults to netbox/media/.
+# Keep the placeholder so the directory exists in a fresh checkout.
 /netbox/media/*
 !/netbox/media/.gitkeep
+
+# Legacy custom reports; REPORTS_ROOT defaults to netbox/reports/.
+# Keep the package marker while ignoring deployment-specific reports.
 /netbox/reports/*
 !/netbox/reports/__init__.py
+
+# Custom scripts; SCRIPTS_ROOT defaults to netbox/scripts/.
+# Keep the package marker while ignoring deployment-specific scripts.
 /netbox/scripts/*
 !/netbox/scripts/__init__.py
-/netbox/static
-/venv/
+
+# Deployment-local WSGI configuration copied from contrib/ and edited in place
+/gunicorn.py
+/uwsgi.ini
+
+# Ignore local helper scripts in the repository root, but keep the tracked upgrade script
 /*.sh
-local_requirements.txt
-local_settings.py
 !upgrade.sh
-fabfile.py
-gunicorn.py
-uwsgi.ini
-netbox.log
-netbox.pid
+
+# Git patch/diff files commonly generated locally for review or handoff
+/*.patch
+/*.diff
+
+# Common local editor, OS, and runtime-manager metadata
+*.swp
 .DS_Store
-.idea
-.coverage
-.vscode
+.idea/
+.vscode/
 .python-version