From 73ec14449f14867e1cbc14a586aa1c0a48fdb65e Mon Sep 17 00:00:00 2001 From: Gurney Buchanan Date: Mon, 20 Apr 2026 14:05:30 -0400 Subject: [PATCH] Add agent-readiness improvements: AGENTS.md, CLAUDE.md, PR/issue templates, .gitignore, pre-commit hooks --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 ++++++++++++++++ .gitignore | 39 ++++++++++++++++++++++- .pre-commit-config.yaml | 11 +++++++ 5 files changed, 134 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .pre-commit-config.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..116fdc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug Report +about: Report a bug to help us improve +title: "[BUG] " +labels: bug +assignees: '' +--- + +## Describe the Bug + + + +## Steps to Reproduce + +1. +2. +3. + +## Expected Behavior + + + +## Actual Behavior + + + +## Environment + +- OS: +- Version: +- Go version (if applicable): + +## Additional Context + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..af6d439 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: "[FEATURE] " +labels: enhancement +assignees: '' +--- + +## Problem Statement + + + +## Proposed Solution + + + +## Alternatives Considered + + + +## Additional Context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a787155 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## Description + + + +## Type of Change + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation update +- [ ] Refactoring (no functional changes) +- [ ] CI/CD or tooling change + +## Testing + + + +- [ ] Unit tests pass (`make test`) +- [ ] Integration tests pass (if applicable) +- [ ] Manual verification completed + +## Checklist + +- [ ] My code follows the project's coding conventions +- [ ] I have updated documentation as needed +- [ ] I have added tests that prove my fix/feature works +- [ ] All new and existing tests pass diff --git a/.gitignore b/.gitignore index ad67ace..0a6c9ee 100644 --- a/.gitignore +++ b/.gitignore @@ -60,4 +60,41 @@ Thumbs.db # Backup files *.bak *.backup -*~ \ No newline at end of file +*~ + +# === Additional patterns for agent-readiness === +# Binaries +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool +*.out +*.prof + +# Go workspace file +go.work +go.work.sum + +# IDE and editor files +.idea/ +.vscode/ +*.swp +*.swo +*~ +.project +.settings/ + +# OS files +.DS_Store +Thumbs.db +Desktop.ini + +# Build output +/bin/ +/dist/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..c328dac --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,11 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-yaml + args: ['--allow-multiple-documents'] + - id: check-added-large-files + args: ['--maxkb=500'] + - id: check-merge-conflict