chore: Add comment explaining why testpackage is enabled

kylecarbs · kylecarbs · commit 8f697af061e6 · 2022-03-31T16:48:58.000Z
A discussion (linked below) was had that touched on why this linter is enabled. To avoid losing that history, adding the comment inline with our linting rules can avoid duplicating this discussion! #741 (comment)
diff --git a/.golangci.yml b/.golangci.yml
@@ -251,6 +251,13 @@ linters:
     - staticcheck
     - structcheck
     - tenv
+    # In Go, it's possible for a package to test it's internal functionality
+    # without testing any exported functions. This is enabled to promote
+    # decomposing a package before testing it's internals. A function caller
+    # should be able to test most of the functionality from exported functions.
+    # 
+    # There are edge-cases to this rule, but they should be carefully considered
+    # to avoid structural inconsistency.
     - testpackage
     - tparallel
     - typecheck
