Add GitHub Actions workflows and fix linting issues

[Copilot]

This PR adds comprehensive CI/CD automation to the repository and addresses all linting issues as requested in the issue.

Changes Made

🔄 GitHub Actions Workflows

Added two new GitHub Actions workflows to automate quality checks:

1. Go Build, Lint and Test (.github/workflows/go.yml)

   • Runs on all pushes to main and pull requests
   • Verifies Go module dependencies with go mod verify
   • Builds the project with go build -v ./...
   • Runs static analysis with go vet
   • Enforces code formatting with gofmt -s
   • Executes tests with race detection and generates coverage reports
   • Uploads coverage to Codecov for tracking

2. Markdown Lint (.github/workflows/markdown-lint.yml)

   • Lints all markdown files in the repository
   • Uses the industry-standard markdownlint-cli2-action
   • Ensures documentation quality and consistency

📛 Workflow Status Badges

Added GitHub Actions workflow status badges to README.md:

• Go Build, Lint and Test badge - Shows the current status of the build/lint/test workflow
• Markdown Lint badge - Shows the current status of the markdown linting workflow

The badges are displayed alongside existing badges (Go Reference and Go Report Card) and link directly to the workflow runs on GitHub Actions.

📝 Linting Fixes

• Fixed all markdown linting issues in README.md and copilot instructions
• Added .markdownlint.json configuration with sensible defaults:
  • Line length limit of 120 characters (balancing readability with practicality)
  • Disabled bare URL warnings for documentation links
  • Maintains consistency across all markdown files
• All Go code already passed linting checks (no changes needed)

📁 File Organization

Moved .copilot-instructions.md to .github/copilot-instructions.md as per GitHub's official specification for Copilot instruction files. This ensures the instructions are properly recognized by GitHub Copilot.

Verification

All changes have been tested:

• ✅ Go builds successfully
• ✅ All tests pass (20+ test cases, 88.7% coverage)
• ✅ go vet reports no issues
• ✅ gofmt confirms all code is properly formatted
• ✅ All markdown files pass linting with 0 errors

The workflows are configured to run automatically on future pushes and pull requests, ensuring code quality is maintained.

Fixes #6

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add Github Actions</issue_title>
<issue_description>1. Add github actions for linting all readme files
2. Add a build/lint/test github workflow
3. Fix any linting issues
4. Move the copilot instructions file to the correct location as specified by Github.com</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #6

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[kmesiab]

@copilot add workflow badges to the readme

[Copilot]

Pull Request Overview

This PR implements GitHub Actions workflows for CI/CD automation and fixes linting issues across the project. The changes enable automated build, lint, and test workflows for both Go code and Markdown documentation.

• Adds comprehensive GitHub Actions workflows for Go build/lint/test and Markdown linting
• Moves Copilot instructions to GitHub's recommended location
• Fixes Markdown formatting issues to comply with linting rules

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
README.md	Adds workflow status badges and fixes line length formatting issue
.markdownlint.json	Configures Markdown linting rules with appropriate line length limits
.github/workflows/go.yml	Implements Go CI workflow with build, lint, format check, and test steps
.github/workflows/markdown-lint.yml	Adds Markdown linting workflow for documentation quality
.github/copilot-instructions.md	Moves and reformats Copilot instructions with proper line wrapping

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

@copilot add workflow badges to the readme

Added workflow badges for both GitHub Actions workflows in commit 564fdaf. The README now displays status badges for:

• Go Build, Lint and Test
• Markdown Lint

The badges appear on lines 7-8 of the README, right after the existing Go Reference and Go Report Card badges.