final updates until PR

Author: codingwithshawnyt

.codecov.yml

@@ -1,12 +1,12 @@
-comment:
-  layout: "reach, diff, flags, files"
-  behavior: default
-  require_changes: false  # if true: only post the comment if coverage changes
-  require_base: no        # [yes :: must have a base report to post]
-  require_head: yes       # [yes :: must have a head report to post]
+.comment:
+  layout: "reach, diff, flags, files"  # Defines the layout of the comment posted by Codecov
+  behavior: default                    # Sets the behavior of the comment (default, once, etc.)
+  require_changes: false               # Only post the comment if coverage changes (false means always post)
+  require_base: no                     # Must have a base report to post (no means it's not required)
+  require_head: yes                    # Must have a head report to post (yes means it's required)
 
 coverage:
   status:
     project:
       default:
-        threshold: 1
+        threshold: 1                   # Minimum coverage percentage change needed to fail the check

.coveragerc

@@ -1,16 +1,20 @@
 [run]
-source = pydriller
+source = gitanalyzer  # Specify the main package to measure coverage for
 
 [report]
-exclude_lines =
-    if self.debug:
-    pragma: no cover
-    raise NotImplementedError
-    if __name__ == .__main__.:
-exclude_also =
-    @(abc\.)?abstractmethod
-ignore_errors = True
-include = */pydriller/*
-omit =
-    tests/*
-    */__init__.py/*
+exclude_lines =  # Lines to exclude from coverage reports
+    if self.debug:  # Exclude debug conditional lines
+    pragma: no cover  # Exclude lines marked explicitly to be not covered
+    raise NotImplementedError  # Exclude lines that raise NotImplementedError
+    if __name__ == .__main__.:  # Exclude script entry point check (note: this line seems to have a typo)
+
+exclude_also =  # Additional patterns to exclude from coverage
+    @(abc\.)?abstractmethod  # Exclude abstract methods, optionally prefixed by 'abc.'
+
+ignore_errors = True  # Continue generating reports even if some files are problematic
+
+include = */gitanalyzer/*  # Include all subdirectories within 'gitanalyzer' for coverage
+
+omit =  # Files or directories to omit from coverage data
+    tests/*  # Omit all files in the 'tests' directory
+    */__init__.py/*  # Omit all '__init__.py' files in any directory

.flake8

@@ -1,6 +1,11 @@
 [flake8]
+# Display the source code generating the error
 show-source = True
+# Count total number of errors and warnings
 count = True
+# Show statistics of errors
 statistics = True
+# Maximum allowed line length
 max-line-length = 150
+# Directories and files to exclude from checks
 exclude = .github,venv,build,dist,docs,test-repos,.venv,tmp.py