docs: update comments in lint

Author: muthukrishnan24

lint/config.go

@@ -1,22 +1,27 @@
 package lint
 
-// Config represent linter config
-type Config struct {
-	Formatter string                `yaml:"formatter"`
-	Rules     map[string]RuleConfig `yaml:"rules"`
-}
-
 // RuleConfig represent config for a rule
 type RuleConfig struct {
-	Enabled  bool        `yaml:"enabled"`
-	Severity Severity    `yaml:"severity"`
+	Enabled bool `yaml:"enabled"`
+
+	Severity Severity `yaml:"severity"`
+
 	Argument interface{} `yaml:"argument"`
 
-	// Optional flags
+	// Flags are optional key value pairs
 	Flags map[string]interface{} `yaml:"flags"`
 }
 
-// GetRule returns RuleConfig for given ruleName
+// Config represent linter config
+type Config struct {
+	// Formatter of the lint result
+	Formatter string `yaml:"formatter"`
+
+	// Rules is rule name to rule config map
+	Rules map[string]RuleConfig `yaml:"rules"`
+}
+
+// GetRule returns RuleConfig for given rule name
 func (c *Config) GetRule(ruleName string) RuleConfig {
 	return c.Rules[ruleName]
 }

lint/constants.go

@@ -6,6 +6,7 @@ const (
 	SeverityError Severity = "error"
 )
 
+// Severity represent the severity level of a rule
 type Severity string
 
 func (s Severity) String() string {

lint/formatter.go

@@ -4,5 +4,7 @@ package lint
 type Formatter interface {
 	// Name is a unique identifier for formatter
 	Name() string
-	Format(res *Result) (string, error)
+
+	// Format formats the linter result
+	Format(result *Result) (string, error)
 }

lint/linter.go

@@ -5,13 +5,13 @@ import (
 	"github.com/conventionalcommit/commitlint/message"
 )
 
-// Linter is a simple linter for conventional commits
+// Linter is linter for commit message
 type Linter struct {
 	conf  *Config
 	rules []Rule
 }
 
-// NewLinter returns a new Linter object with given conf
+// NewLinter returns a new Linter instance with given config and rules
 func NewLinter(conf *Config, rules []Rule) (*Linter, error) {
 	return &Linter{conf: conf, rules: rules}, nil
 }
@@ -28,7 +28,7 @@ func (l *Linter) Lint(commitMsg string) (*Result, error) {
 	return l.LintCommit(msg)
 }
 
-// LintCommit checks the given parser.Commit for rules
+// LintCommit checks the given message.Commit against rules
 func (l *Linter) LintCommit(msg *message.Commit) (*Result, error) {
 	res := newResult(msg.FullCommit)
 

lint/rule.go

@@ -13,5 +13,7 @@ type Rule interface {
 	Apply(arg interface{}, flags map[string]interface{}) error
 
 	// Validate validates the rule for given message
+	// if given message is valid, return true and result string is ignored
+	// if invalid, return a error result with false
 	Validate(msg *message.Commit) (result string, isValid bool)
 }