internal/validation/validation.go

@@ -1,3 +1,4 @@
+// Package validation General validation tasks
 package validation
 
 import (
@@ -6,6 +7,7 @@ import (
 	"strings"
 )
 
+// ValidateConventionalCommit validates if string follows conventional commit
 func ValidateConventionalCommit(commit string) error {
 	// Regex to match the commit format
 	// type(scope)!: description

main.go

@@ -1,3 +1,4 @@
+// Package main is the main package
 package main
 
 import (
@@ -8,6 +9,7 @@ import (
 	"git.kjan.de/actions/pull-request-lint/internal/validation"
 )
 
+// GithubEvent represents a github actions event
 type GithubEvent struct {
 	PullRequest struct {
 		Title string `json:"title"`