Change ACKNOWLEDGE_COAUTHORS default to True

Co-authored-by: zkoppert <6935431+zkoppert@users.noreply.github.com>

Author: Copilot

.env-example

@@ -6,7 +6,7 @@ REPOSITORY = "organization/repository"
 START_DATE = ""
 SPONSOR_INFO = "False"
 LINK_TO_PROFILE = "True"
-ACKNOWLEDGE_COAUTHORS = "False"
+ACKNOWLEDGE_COAUTHORS = "True"
 
 # GITHUB APP
 GH_APP_ID = ""

README.md

@@ -93,7 +93,7 @@ This action can be configured to authenticate with GitHub App Installation or Pe
 | `END_DATE`              | False                                           | Current Date      | The date at which you want to stop gathering contributor information. Must be later than the `START_DATE`. ie. Aug 2nd, 2023 would be `2023-08-02`                                                                       |
 | `SPONSOR_INFO`          | False                                           | False             | If you want to include sponsor information in the output. This will include the sponsor count and the sponsor URL. This will impact action performance. ie. SPONSOR_INFO = "False" or SPONSOR_INFO = "True"              |
 | `LINK_TO_PROFILE`       | False                                           | True              | If you want to link usernames to their GitHub profiles in the output. ie. LINK_TO_PROFILE = "True" or LINK_TO_PROFILE = "False"                                                                                          |
-| `ACKNOWLEDGE_COAUTHORS` | False                                           | False             | If you want to include co-authors from commit messages as contributors. Co-authors are identified via the `Co-authored-by:` trailer in commit messages using the GitHub noreply email format (e.g., `username@users.noreply.github.com`). This will impact action performance as it requires scanning all commits. ie. ACKNOWLEDGE_COAUTHORS = "True" or ACKNOWLEDGE_COAUTHORS = "False" |
+| `ACKNOWLEDGE_COAUTHORS` | False                                           | True              | If you want to include co-authors from commit messages as contributors. Co-authors are identified via the `Co-authored-by:` trailer in commit messages using the GitHub noreply email format (e.g., `username@users.noreply.github.com`). This will impact action performance as it requires scanning all commits. ie. ACKNOWLEDGE_COAUTHORS = "True" or ACKNOWLEDGE_COAUTHORS = "False" |
 
 **Note**: If `start_date` and `end_date` are specified then the action will determine if the contributor is new. A new contributor is one that has contributed in the date range specified but not before the start date.
 

env.py

@@ -147,7 +147,7 @@ def get_env_vars(
 
     sponsor_info = get_bool_env_var("SPONSOR_INFO", False)
     link_to_profile = get_bool_env_var("LINK_TO_PROFILE", False)
-    acknowledge_coauthors = get_bool_env_var("ACKNOWLEDGE_COAUTHORS", False)
+    acknowledge_coauthors = get_bool_env_var("ACKNOWLEDGE_COAUTHORS", True)
 
     # Separate repositories_str into a list based on the comma separator
     repositories_list = []

test_env.py

@@ -80,7 +80,7 @@ def test_get_env_vars(self):
         self.assertEqual(end_date, "2022-12-31")
         self.assertFalse(sponsor_info)
         self.assertTrue(link_to_profile)
-        self.assertFalse(acknowledge_coauthors)
+        self.assertTrue(acknowledge_coauthors)
 
     @patch.dict(
         os.environ,
@@ -192,7 +192,7 @@ def test_get_env_vars_no_dates(self):
         self.assertEqual(end_date, "")
         self.assertFalse(sponsor_info)
         self.assertTrue(link_to_profile)
-        self.assertFalse(acknowledge_coauthors)
+        self.assertTrue(acknowledge_coauthors)
 
     @patch.dict(os.environ, {})
     def test_get_env_vars_missing_org_or_repo(self):