docs(linter): comment why goheader is only enabled in the CI (#101)

Author: qdm12

.github/workflows/golangci-lint.yml

@@ -27,4 +27,8 @@ jobs:
         with:
           version: v1.60
           only-new-issues: true
+          # The goheader linter is enabled so that it runs only on modified or new files
+          # (see only-new-issues: true). Note it is disabled in .golangci.yml because
+          # golangci-lint is not aware of new/modified files compared to the last git commit,
+          # and we want to avoid reporting invalid goheader errors when running the linter locally.
           args: --enable goheader

.golangci.yml

@@ -16,6 +16,9 @@ linters:
     - gci
     - gocheckcompilerdirectives
     - gofmt
+    # goheader is disabled but it is enabled in the CI with a flag.
+    # Please see .github/workflows/golangci-lint.yml which explains why.
+    # - goheader
     - goimports
     - gomodguard
     - gosec
@@ -72,8 +75,8 @@ linters-settings:
         disabled: true
 
 issues:
-   exclude-dirs-use-default: false
-   exclude-rules:
+  exclude-dirs-use-default: false
+  exclude-rules:
     - path-except: libevm
       linters:
         # If any issue is flagged in a non-libevm file, add the linter here
@@ -104,19 +107,19 @@ issues:
         - varnamelen
         - wastedassign
         - whitespace
-   include:
-   # Many of the default exclusions are because, verbatim "Annoying issue",
-   # which defeats the point of a linter.
-        - EXC0002
-        - EXC0004
-        - EXC0005
-        - EXC0006
-        - EXC0007
-        - EXC0008
-        - EXC0009
-        - EXC0010
-        - EXC0011
-        - EXC0012
-        - EXC0013
-        - EXC0014
-        - EXC0015
+  include:
+    # Many of the default exclusions are because, verbatim "Annoying issue",
+    # which defeats the point of a linter.
+    - EXC0002
+    - EXC0004
+    - EXC0005
+    - EXC0006
+    - EXC0007
+    - EXC0008
+    - EXC0009
+    - EXC0010
+    - EXC0011
+    - EXC0012
+    - EXC0013
+    - EXC0014
+    - EXC0015