Merge pull request #38 from srishtea-22/refactor/project-structure

refactor: restructure project to follow Go conventions

Author: DFanso

.github/workflows/build-and-release.yml

@@ -78,9 +78,9 @@ jobs:
       - name: Build
         run: |
           if [ "${{ matrix.os }}" = "windows-latest" ]; then
-            go build -v -o ${{ matrix.artifact_name }} -ldflags="-s -w" ./src
+            go build -v -o ${{ matrix.artifact_name }} -ldflags="-s -w" ./cmd/commit-msg
           else
-            go build -v -o ${{ matrix.artifact_name }} -ldflags="-s -w" ./src
+            go build -v -o ${{ matrix.artifact_name }} -ldflags="-s -w" ./cmd/commit-msg
           fi
         shell: bash
 

CONTRIBUTING.md

@@ -104,12 +104,12 @@ Improving documentation is always appreciated:
 3. Run the application:
 
    ```bash
-   go run src/main.go .
+   go run cmd/commit-msg/main.go .
    ```
 
 4. Build the executable:
    ```bash
-   go build -o commit.exe src/main.go
+   go build -o commit.exe cmd/commit-msg/main.go
    ```
 
 ### Testing Your Changes

README.md

@@ -11,7 +11,7 @@
 
 Below is a sample execution of `commit-msg`:
 
-![Commit-msg GIF](commit.gif)
+![Commit-msg GIF](assets/commit.gif)
 
 Before running the application, ensure you have set the system environment variables. and add commit.exe to path variables (same for linux macOS)
 
@@ -102,7 +102,7 @@ cd commit-msg
 go mod download
 
 # Build the executable
-go build -o commit src/main.go
+go build -o commit cmd/commit-msg/main.go
 
 # (Optional) Install to GOPATH
 go install
@@ -123,7 +123,7 @@ commit .
 Or if running from source:
 
 ```bash
-go run src/main.go .
+go run cmd/commit-msg/main.go .
 ```
 
 ### Example Workflow

commit.gif assets/commit.gifcommit.gif renamed to assets/commit.gif

@@ -5,14 +5,14 @@ import (
 	"os"
 
 	"github.com/atotto/clipboard"
-	"github.com/dfanso/commit-msg/src/chatgpt"
-	"github.com/dfanso/commit-msg/src/claude"
-	"github.com/dfanso/commit-msg/src/gemini"
-	"github.com/dfanso/commit-msg/src/grok"
-	"github.com/dfanso/commit-msg/src/internal/display"
-	"github.com/dfanso/commit-msg/src/internal/git"
-	"github.com/dfanso/commit-msg/src/internal/stats"
-	"github.com/dfanso/commit-msg/src/types"
+	"github.com/dfanso/commit-msg/internal/chatgpt"
+	"github.com/dfanso/commit-msg/internal/claude"
+	"github.com/dfanso/commit-msg/internal/display"
+	"github.com/dfanso/commit-msg/internal/gemini"
+	"github.com/dfanso/commit-msg/internal/git"
+	"github.com/dfanso/commit-msg/internal/grok"
+	"github.com/dfanso/commit-msg/internal/stats"
+	"github.com/dfanso/commit-msg/pkg/types"
 	"github.com/pterm/pterm"
 )
 

image.png assets/image.pngimage.png renamed to assets/image.png

@@ -7,7 +7,7 @@ import (
 	openai "github.com/openai/openai-go/v3"
 	"github.com/openai/openai-go/v3/option"
 
-	"github.com/dfanso/commit-msg/src/types"
+	"github.com/dfanso/commit-msg/pkg/types"
 )
 
 func GenerateCommitMessage(config *types.Config, changes string, apiKey string) (string, error) {

src/main.go cmd/commit-msg/main.gosrc/main.go renamed to cmd/commit-msg/main.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"net/http"
 
-	"github.com/dfanso/commit-msg/src/types"
+	"github.com/dfanso/commit-msg/pkg/types"
 )
 
 type ClaudeRequest struct {

src/chatgpt/chatgpt.go internal/chatgpt/chatgpt.gosrc/chatgpt/chatgpt.go renamed to internal/chatgpt/chatgpt.go

@@ -7,7 +7,7 @@ import (
 	"github.com/google/generative-ai-go/genai"
 	"google.golang.org/api/option"
 
-	"github.com/dfanso/commit-msg/src/types"
+	"github.com/dfanso/commit-msg/pkg/types"
 )
 
 func GenerateCommitMessage(config *types.Config, changes string, apiKey string) (string, error) {