Improved Docstring Coverage

Author: Muneer320

cmd/cli/createMsg.go

@@ -24,6 +24,8 @@ import (
 	"github.com/pterm/pterm"
 )
 
+// CreateCommitMsg launches the interactive flow for reviewing, regenerating,
+// editing, and accepting AI-generated commit messages in the current repo.
 func CreateCommitMsg() {
 	// Validate COMMIT_LLM and required API keys
 	useLLM, err := store.DefaultLLMKey()

cmd/cli/llmSetup.go

@@ -9,6 +9,8 @@ import (
 	"github.com/manifoldco/promptui"
 )
 
+// SetupLLM walks the user through selecting an LLM provider and storing the
+// corresponding API key or endpoint configuration.
 func SetupLLM() error {
 
 	providers := types.GetSupportedProviderStrings()
@@ -67,6 +69,8 @@ func SetupLLM() error {
 	return nil
 }
 
+// UpdateLLM lets the user switch defaults, rotate API keys, or delete stored
+// LLM provider configurations.
 func UpdateLLM() error {
 
 	SavedModels, err := store.ListSavedModels()

cmd/cli/store/store.go

@@ -1,3 +1,4 @@
+// Package store persists user-selected LLM providers and credentials.
 package store
 
 import (
@@ -11,16 +12,19 @@ import (
 	"github.com/dfanso/commit-msg/pkg/types"
 )
 
+// LLMProvider represents a single stored LLM provider and its credential.
 type LLMProvider struct {
 	LLM    types.LLMProvider `json:"model"`
 	APIKey string            `json:"api_key"`
 }
 
+// Config describes the on-disk structure for all saved LLM providers.
 type Config struct {
 	Default      types.LLMProvider `json:"default"`
 	LLMProviders []LLMProvider     `json:"models"`
 }
 
+// Save persists or updates an LLM provider entry, marking it as the default.
 func Save(LLMConfig LLMProvider) error {
 
 	cfg := Config{
@@ -139,6 +143,7 @@ func getConfigPath() (string, error) {
 
 }
 
+// DefaultLLMKey returns the currently selected default LLM provider, if any.
 func DefaultLLMKey() (*LLMProvider, error) {
 
 	var cfg Config
@@ -179,6 +184,7 @@ func DefaultLLMKey() (*LLMProvider, error) {
 	return nil, errors.New("not found default model in config")
 }
 
+// ListSavedModels loads all persisted LLM provider configurations.
 func ListSavedModels() (*Config, error) {
 
 	var cfg Config
@@ -211,6 +217,7 @@ func ListSavedModels() (*Config, error) {
 
 }
 
+// ChangeDefault updates the default LLM provider selection in the config.
 func ChangeDefault(Model types.LLMProvider) error {
 
 	var cfg Config
@@ -247,6 +254,7 @@ func ChangeDefault(Model types.LLMProvider) error {
 	return os.WriteFile(configPath, data, 0600)
 }
 
+// DeleteModel removes the specified provider from the saved configuration.
 func DeleteModel(Model types.LLMProvider) error {
 
 	var cfg Config
@@ -300,6 +308,7 @@ func DeleteModel(Model types.LLMProvider) error {
 	}
 }
 
+// UpdateAPIKey rotates the credential for an existing provider entry.
 func UpdateAPIKey(Model types.LLMProvider, APIKey string) error {
 
 	var cfg Config

internal/chatgpt/chatgpt.go

@@ -10,6 +10,8 @@ import (
 	"github.com/dfanso/commit-msg/pkg/types"
 )
 
+// GenerateCommitMessage calls OpenAI's chat completions API to turn the provided
+// repository changes into a polished git commit message.
 func GenerateCommitMessage(config *types.Config, changes string, apiKey string, opts *types.GenerationOptions) (string, error) {
 
 	client := openai.NewClient(option.WithAPIKey(apiKey))

internal/claude/claude.go

@@ -10,17 +10,20 @@ import (
 	"github.com/dfanso/commit-msg/pkg/types"
 )
 
+// ClaudeRequest describes the payload sent to Anthropic's Claude messages API.
 type ClaudeRequest struct {
 	Model     string    `json:"model"`
 	Messages  []Message `json:"messages"`
 	MaxTokens int       `json:"max_tokens"`
 }
 
+// Message represents a single role/content pair exchanged with Claude.
 type Message struct {
 	Role    string `json:"role"`
 	Content string `json:"content"`
 }
 
+// ClaudeResponse captures the subset of fields used from Anthropic responses.
 type ClaudeResponse struct {
 	ID      string `json:"id"`
 	Type    string `json:"type"`
@@ -30,6 +33,7 @@ type ClaudeResponse struct {
 	} `json:"content"`
 }
 
+// GenerateCommitMessage produces a commit summary using Anthropic's Claude API.
 func GenerateCommitMessage(config *types.Config, changes string, apiKey string, opts *types.GenerationOptions) (string, error) {
 
 	prompt := types.BuildCommitPrompt(changes, opts)

internal/gemini/gemini.go

@@ -10,6 +10,8 @@ import (
 	"github.com/dfanso/commit-msg/pkg/types"
 )
 
+// GenerateCommitMessage asks Google Gemini to author a commit message for the
+// supplied repository changes and optional style instructions.
 func GenerateCommitMessage(config *types.Config, changes string, apiKey string, opts *types.GenerationOptions) (string, error) {
 	// Prepare request to Gemini API
 	prompt := types.BuildCommitPrompt(changes, opts)

internal/grok/grok.go

@@ -12,6 +12,8 @@ import (
 	"github.com/dfanso/commit-msg/pkg/types"
 )
 
+// GenerateCommitMessage calls X.AI's Grok API to create a commit message from
+// the provided Git diff and generation options.
 func GenerateCommitMessage(config *types.Config, changes string, apiKey string, opts *types.GenerationOptions) (string, error) {
 	// Prepare request to X.AI (Grok) API
 	prompt := types.BuildCommitPrompt(changes, opts)

internal/ollama/ollama.go

@@ -10,16 +10,20 @@ import (
 	"github.com/dfanso/commit-msg/pkg/types"
 )
 
+// OllamaRequest captures the prompt payload sent to an Ollama HTTP endpoint.
 type OllamaRequest struct {
 	Model  string `json:"model"`
 	Prompt string `json:"prompt"`
 }
 
+// OllamaResponse represents the non-streaming response from Ollama.
 type OllamaResponse struct {
 	Response string `json:"response"`
 	Done     bool   `json:"done"`
 }
 
+// GenerateCommitMessage uses a locally hosted Ollama model to draft a commit
+// message from repository changes and optional style guidance.
 func GenerateCommitMessage(_ *types.Config, changes string, url string, model string, opts *types.GenerationOptions) (string, error) {
 	// Use llama3:latest as the default model
 	if model == "" {

pkg/types/prompt.go

@@ -5,6 +5,8 @@ import (
 	"strings"
 )
 
+// CommitPrompt is the base instruction template sent to LLM providers before
+// appending repository changes and optional style guidance.
 var CommitPrompt = `I need a concise git commit message based on the following changes from my Git repository.
 Please generate a commit message that:
 1. Starts with a verb in the present tense (e.g., "Add", "Fix", "Update", "Feat", "Refactor", etc.)

pkg/types/types.go

@@ -19,6 +19,8 @@ func (p LLMProvider) IsValid() bool {
 	switch p {
 	case ProviderOpenAI, ProviderClaude, ProviderGemini, ProviderGrok, ProviderGroq, ProviderOllama:
 		return true
+	// LLMProvider identifies the large language model backend used to author
+	// commit messages.
 	default:
 		return false
 	}
@@ -30,11 +32,14 @@ func GetSupportedProviders() []LLMProvider {
 		ProviderClaude,
 		ProviderGemini,
 		ProviderGrok,
+		// String returns the string form of the provider identifier.
 		ProviderGroq,
 		ProviderOllama,
 	}
 }
 
+// IsValid reports whether the provider is part of the supported set.
+
 func GetSupportedProviderStrings() []string {
 	providers := GetSupportedProviders()
 	strings := make([]string, len(providers))
@@ -44,6 +49,8 @@ func GetSupportedProviderStrings() []string {
 	return strings
 }
 
+// GetSupportedProviders returns all available provider enums.
+
 func ParseLLMProvider(s string) (LLMProvider, bool) {
 	provider := LLMProvider(s)
 	return provider, provider.IsValid()
@@ -55,6 +62,8 @@ type Config struct {
 	Repos   map[string]RepoConfig `json:"repos"`
 }
 
+// GetSupportedProviderStrings returns the human-friendly names for providers.
+
 // Repository configuration
 type RepoConfig struct {
 	Path    string `json:"path"`
@@ -63,6 +72,7 @@ type RepoConfig struct {
 
 // Grok/X.AI API request structure
 type GrokRequest struct {
+	// ParseLLMProvider converts a string into an LLMProvider enum when supported.
 	Messages    []Message `json:"messages"`
 	Model       string    `json:"model"`
 	Stream      bool      `json:"stream"`