docs: update package comments for clarity
This commit is contained in:
parent
79e4f6c2bf
commit
f0839e48e1
2 changed files with 4 additions and 0 deletions
|
@ -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
|
||||
|
|
2
main.go
2
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"`
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue