From 932d1cf8028d0a0f9d8c2c53fe54a574f4e8dfd7 Mon Sep 17 00:00:00 2001
From: Dean Brettle <dean@brettle.com>
Date: Thu, 25 Apr 2024 15:08:50 -0700
Subject: [PATCH] Remove overriden setting so CI passes.

Also add some clarifying comments and use a better test name for the test that fails when a setting is overriden.
---
 src/main/java/org/carlmontrobotics/Config.java     | 6 +++++-
 src/test/java/org/carlmontrobotics/ConfigTest.java | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/carlmontrobotics/Config.java b/src/main/java/org/carlmontrobotics/Config.java
index 77d168c4..0d691ee8 100644
--- a/src/main/java/org/carlmontrobotics/Config.java
+++ b/src/main/java/org/carlmontrobotics/Config.java
@@ -12,7 +12,11 @@ abstract class Config implements Sendable {
     public static final Config CONFIG = new Config() {
         {
             // Override config settings here, like this:
-            this.exampleFlagEnabled = true;
+            // this.exampleFlagEnabled = true;
+
+            // NOTE: PRs with overrides will NOT be merged because we don't want them
+            // polluting the master branch.
+            // Feel free to add them when testing, but remove them before pushing.
         }
     };
 
diff --git a/src/test/java/org/carlmontrobotics/ConfigTest.java b/src/test/java/org/carlmontrobotics/ConfigTest.java
index 88689ac9..3b0575aa 100644
--- a/src/test/java/org/carlmontrobotics/ConfigTest.java
+++ b/src/test/java/org/carlmontrobotics/ConfigTest.java
@@ -65,7 +65,7 @@ public void testToString() {
 
     @Test
     @EnabledIfEnvironmentVariable(named = "testCONFIGIsDefault", matches = "true", disabledReason = "not trying to modify GitHub master")
-    public void testCONFIGIsDefault() throws Exception {
+    public void testNoConfigSettingsOverridden() throws Exception {
         var publishedStrings = new HashMap<String, String>();
         try (SendableBuilder testBuilder = new SendableBuilderImpl() {
             @Override