docs: fix lint errors by providing package documentation

pkg/author/author.go

@@ -1,3 +1,15 @@
+/*
+Package author provides functions for working with Git commit authors and co-authors.
+
+This package includes functions for retrieving suggested co-authors who have made commits in the Git repository.
+It uses the `git log` command to extract author names and email addresses from the commit history. The resulting list
+of authors can be used when creating Git commits with co-authors.
+
+Usage:
+  - Call the GetSuggestedCoAuthors function to obtain a list of suggested co-authors based on the Git commit history.
+
+Copyright © 2023 HENRI REMONEN <[email protected]>
+*/
 package author
 
 import (

pkg/commit/commit_info.go → pkg/commit/info.go

@@ -1,21 +1,21 @@
 /*
 Package commit provides functionality for creating Git commits.
 
-The CommitInfo struct in this package represents information needed for creating a Git commit. It includes fields for specifying the commit type, scope, description, body, co-authors, and breaking change details.
+The Info struct in this package represents information needed for creating a Git commit. It includes fields for specifying the commit type, scope, description, body, co-authors, and breaking change details.
 
 Usage:
-  - Create instances of the CommitInfo struct to define commit information.
+  - Create instances of the Info struct to define commit information.
   - Set the CommitType, CommitDescription, and other fields to configure the commit.
   - Optionally, add co-authors to the CoAuthors field if the commit is co-authored.
   - Use the IsBreakingChange field to indicate whether the commit introduces a breaking change.
-  - For more information on how to use the CommitInfo struct and create Git commits, refer to the package-specific functions and commands.
+  - For more information on how to use the Info struct and create Git commits, refer to the package-specific functions and commands.
 
 Copyright © 2023 HENRI REMONEN <[email protected]>
 */
 package commit
 
-// CommitInfo represents information needed for creating a Git commit.
-type CommitInfo struct {
+// Info represents information needed for creating a Git commit.
+type Info struct {
 	CommitType                string
 	CommitScope               string
 	CommitDescription         string

pkg/validators/string_validators.go

@@ -1,3 +1,14 @@
+/*
+Package validators provides a collection of utility functions for validating various data types.
+
+This package includes functions for validating different types of data, such as strings, numbers, and more. It serves as a library of validation functions that can be used across various applications.
+
+Usage:
+  - Explore the available validation functions to find the one that suits your validation needs.
+  - Call the relevant validation function to ensure the integrity of your data.
+
+Copyright © 2023 HENRI REMONEN <[email protected]>
+*/
 package validators
 
 import "fmt"