Add optional pre-commit hook for code formatting

.editorconfig

@@ -208,13 +208,3 @@ indent_style = unset
 insert_final_newline = false
 tab_width = unset
 trim_trailing_whitespace = false
-
-# Disable AOT analyser for test files
-[test/**/*.cs]
-dotnet_diagnostic.IL2026.severity = none
-dotnet_diagnostic.IL2070.severity = none
-dotnet_diagnostic.IL2075.severity = none
-dotnet_diagnostic.IL2090.severity = none
-
-# This appears to be broken and results in false positives (causing dotnet format to delete valid test scenarios)
-dotnet_diagnostic.xUnit1025.severity = none

.gitattributes

@@ -3,6 +3,7 @@
 *.sln text=auto eol=crlf
 *.slnx text=auto eol=lf
 *.sh eol=lf
+.githooks/* eol=lf
 *.ps1 eol=lf
 CHANGELOG.md merge=union
 

.githooks/pre-commit

@@ -0,0 +1,45 @@
+#!/bin/bash
+set -e
+
+echo "🔍 Checking code formatting..."
+
+if ! git diff --quiet; then
+  echo "⚠️  Skipping format check: unstaged changes present."
+  echo "   Stage or stash all changes before committing to enable the format check."
+  exit 0
+fi
+
+INCLUDE_ARGS=()
+while IFS= read -r f; do
+  INCLUDE_ARGS+=(--include "$f")
+done < <(git diff --cached --name-only --diff-filter=ACM | grep '\.cs$' || true)
+
+if [ ${#INCLUDE_ARGS[@]} -eq 0 ]; then
+  echo "✅ No C# files staged."
+  exit 0
+fi
+
+FORMAT_OUTPUT=$(dotnet format Sentry.slnx --no-restore \
+  "${INCLUDE_ARGS[@]}" \
+  --exclude ./modules "./**/*OptionsSetup.cs" ./test/Sentry.Tests/AttributeReaderTests.cs 2>&1) || {
+  echo ""
+  echo "❌ dotnet format failed:"
+  echo "$FORMAT_OUTPUT"
+  echo ""
+  exit 1
+}
+
+if ! git diff --quiet; then
+  echo ""
+  echo "❌ Code formatting issues found!"
+  echo ""
+  echo "Please stage the formatting fixes and commit again:"
+  echo ""
+  echo "  git add -u"
+  echo "  git commit"
+  echo ""
+  exit 1
+fi
+
+echo "✅ Code formatting looks good!"
+exit 0

CONTRIBUTING.md

@@ -91,6 +91,31 @@ These solution filters get generated automatically by `/scripts/generate-solutio
 
 Also note that script generates a `.generated.NoMobile.slnx` solution, which is an identical copy of `Sentry.slnx`. Again, we don't recommend opening this directly. It exists as a round about way to conditionally set build properties based on the solution name in certain solution filters. You should instead use those solution filters (e.g. `SentryNoMobile.slnf`) when working in the Sentry codebase.
 
+## Git Hooks (Optional but Recommended)
+
+To automatically check and fix code formatting before committing, you can set up a pre-commit hook:
+
+```bash
+./dev.cs setup-hooks
+```
+
+Before each commit, the hook runs `dotnet format` against your staged `.cs` files and auto-fixes any formatting issues. If fixes were applied, the commit is blocked — just stage the fixes and try again:
+
+```bash
+git add -u
+git commit
+```
+
+Note: the hook skips automatically if you have unstaged changes, to avoid touching work in progress.
+
+To opt out at any time:
+
+```bash
+./dev.cs remove-hooks
+```
+
+**Note:** You can also bypass the hook for a specific commit using `git commit --no-verify` if needed.
+
 ## API changes approval process
 
 This repository uses [Verify](https://github.com/VerifyTests/Verify) to store the public API diffs in snapshot files. When a change involves modifying the public API area (by for example adding a public method), that change will need to be approved, otherwise the CI process will fail.

dev.cs

@@ -103,6 +103,25 @@ public Task<int> AiUpdateAsync(GlobalOptions options = default!)
         return RunStepAsync("npx @sentry/dotagents install", "npx", "@sentry/dotagents install", options.DryRun);
     }
 
+    [Command("setup-hooks", Description = "Configure git to use the repo's pre-commit hooks from .githooks/.")]
+    public Task<int> SetupHooksAsync(GlobalOptions options = default!)
+    {
+        Console.WriteLine("[dev] Configuring git hooks path to .githooks/");
+        return RunStepAsync("git config core.hooksPath", "git", "config core.hooksPath .githooks", options.DryRun);
+    }
+
+    [Command("remove-hooks", Description = "Restore default git hooks behaviour (stops using .githooks/).")]
+    public async Task<int> RemoveHooksAsync(GlobalOptions options = default!)
+    {
+        Console.WriteLine("[dev] Restoring default git hooks path");
+        var exitCode = await RunStepAsync("git config --unset core.hooksPath", "git", "config --unset core.hooksPath", options.DryRun);
+
+        // git exits with code 5 when the key doesn't exist. That's already the
+        // desired end state, so treat it as success to keep remove-hooks idempotent
+        // (e.g. running it twice, or before setup-hooks).
+        return exitCode == 5 ? 0 : exitCode;
+    }
+
     [Command("nrest", Description = "Restore the default CI solution.")]
     public Task<int> SolutionRestoreAsync(
         [Argument("solution", Description = "Solution file to restore. Defaults to platform-specific CI solution if omitted.")] string? solution = null,

test/.editorconfig

@@ -0,0 +1,14 @@
+# Settings that apply only to test code under /test
+# (kept here so diagnostic suppressions for tests are easy to find).
+
+[*.cs]
+
+# Disable AOT analyser for test files
+dotnet_diagnostic.IL2026.severity = none
+dotnet_diagnostic.IL2070.severity = none
+dotnet_diagnostic.IL2075.severity = none
+dotnet_diagnostic.IL2090.severity = none
+dotnet_diagnostic.CA2255.severity = none
+
+# This appears to be broken and results in false positives (causing dotnet format to delete valid test scenarios)
+dotnet_diagnostic.xUnit1025.severity = none

test/CommonModuleInit.cs

@@ -2,7 +2,6 @@
 public static class CommonModuleInit
 {
     [ModuleInitializer]
-    [SuppressMessage("Usage", "CA2255:The \'ModuleInitializer\' attribute should not be used in libraries")]
     public static void Init()
     {
         VerifyDiffPlex.Initialize();

test/Sentry.Tests/ModuleInit.cs

@@ -2,7 +2,6 @@
 public static class ModuleInit
 {
     [ModuleInitializer]
-    [SuppressMessage("Usage", "CA2255:The \'ModuleInitializer\' attribute should not be used in libraries")]
     public static void Init()
     {
         CultureInfo.DefaultThreadCurrentUICulture = new CultureInfo("en-US");