Merge pull request #1 from BaseMax/copilot/build-go-error-report-tool

[WIP] Build tool for structured error reports collection

Author: BaseMax

.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, copilot/* ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: ['1.21', '1.22', '1.23']
+    
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ matrix.go-version }}
+
+    - name: Cache Go modules
+      uses: actions/cache@v3
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Download dependencies
+      run: go mod download
+
+    - name: Verify dependencies
+      run: go mod verify
+
+    - name: Run tests
+      run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
+
+    - name: Upload coverage
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.txt
+        flags: unittests
+        name: codecov-umbrella
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.23'
+
+    - name: Build
+      run: go build -v -o errorvault ./cmd/errorvault
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: errorvault
+        path: errorvault
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.23'
+
+    - name: Run golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+        version: latest
+        args: --timeout=5m

.gitignore

@@ -0,0 +1,34 @@
+# Binaries
+errorvault
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary
+*.test
+
+# Output of the go coverage tool
+*.out
+
+# Dependency directories
+vendor/
+
+# Go workspace file
+go.work
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Application data
+*.db
+*.db-journal
+.errorvault/

.golangci.yml

@@ -0,0 +1,21 @@
+linters:
+  enable:
+    - gofmt
+    - govet
+    - staticcheck
+    - errcheck
+    - gosimple
+    - ineffassign
+    - unused
+
+linters-settings:
+  govet:
+    check-shadowing: true
+  errcheck:
+    check-blank: true
+
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - errcheck

CONTRIBUTING.md

@@ -0,0 +1,228 @@
+# Contributing to Error Vault
+
+Thank you for your interest in contributing to Error Vault! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+Be respectful and constructive in all interactions with the project and community.
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. Check if the bug has already been reported in the Issues section
+2. If not, create a new issue with:
+   - Clear title and description
+   - Steps to reproduce
+   - Expected vs actual behavior
+   - Environment details (OS, Go version, etc.)
+
+### Suggesting Features
+
+1. Check if the feature has already been suggested
+2. Create a new issue with:
+   - Clear description of the feature
+   - Use cases and benefits
+   - Possible implementation approach
+
+### Contributing Code
+
+1. Fork the repository
+2. Create a new branch for your feature/fix:
+   ```bash
+   git checkout -b feature/my-feature
+   ```
+3. Make your changes following our coding standards
+4. Write or update tests
+5. Ensure all tests pass:
+   ```bash
+   make test
+   ```
+6. Format your code:
+   ```bash
+   make fmt
+   ```
+7. Run linter:
+   ```bash
+   make vet
+   ```
+8. Commit your changes with clear messages
+9. Push to your fork
+10. Create a Pull Request
+
+## Development Setup
+
+### Prerequisites
+
+- Go 1.21 or later
+- SQLite3
+- Make (optional but recommended)
+
+### Getting Started
+
+```bash
+# Clone your fork
+git clone https://github.com/YOUR_USERNAME/go-error-vault.git
+cd go-error-vault
+
+# Download dependencies
+go mod download
+
+# Build
+make build
+
+# Run tests
+make test
+
+# Run locally
+./errorvault server
+```
+
+## Project Structure
+
+```
+go-error-vault/
+├── cmd/errorvault/        # CLI application
+├── pkg/                   # Public packages
+│   ├── api/              # HTTP server
+│   ├── collector/        # File collection
+│   ├── models/           # Data models
+│   └── storage/          # Database layer
+├── internal/             # Private packages
+│   └── config/          # Configuration
+├── examples/             # Integration examples
+└── web/                  # Web UI assets
+```
+
+## Coding Standards
+
+### Go Code Style
+
+- Follow standard Go conventions
+- Use `gofmt` for formatting
+- Use meaningful variable and function names
+- Add comments for exported functions and types
+- Keep functions small and focused
+- Handle errors explicitly
+
+### Testing
+
+- Write unit tests for new functionality
+- Maintain or improve code coverage
+- Use table-driven tests where appropriate
+- Mock external dependencies
+
+Example test:
+
+```go
+func TestFeature(t *testing.T) {
+    tests := []struct {
+        name    string
+        input   string
+        want    string
+        wantErr bool
+    }{
+        // Test cases
+    }
+
+    for _, tt := range tests {
+        t.Run(tt.name, func(t *testing.T) {
+            // Test implementation
+        })
+    }
+}
+```
+
+### Commit Messages
+
+- Use present tense ("Add feature" not "Added feature")
+- Keep first line under 72 characters
+- Add detailed description for complex changes
+- Reference issues when applicable
+
+Example:
+```
+Add error filtering by date range
+
+- Add date range parameters to storage queries
+- Update API endpoints to accept date filters
+- Add tests for date filtering
+
+Fixes #123
+```
+
+## Pull Request Process
+
+1. Update documentation if needed
+2. Add tests for new features
+3. Ensure all tests pass
+4. Update CHANGELOG.md (if exists)
+5. Request review from maintainers
+
+### PR Checklist
+
+- [ ] Code follows project style
+- [ ] Tests added/updated
+- [ ] Tests pass
+- [ ] Documentation updated
+- [ ] Commit messages are clear
+- [ ] No merge conflicts
+
+## Building and Testing
+
+### Building
+
+```bash
+# Standard build
+make build
+
+# Optimized build
+make build-optimized
+
+# Install system-wide
+make install
+```
+
+### Testing
+
+```bash
+# Run all tests
+make test
+
+# Run with coverage
+make test-cover
+
+# Run specific package tests
+go test ./pkg/storage -v
+```
+
+### Code Quality
+
+```bash
+# Format code
+make fmt
+
+# Run vet
+make vet
+
+# Clean build artifacts
+make clean
+```
+
+## Documentation
+
+- Update README.md for user-facing changes
+- Update code comments for API changes
+- Add examples for new features
+- Keep documentation clear and concise
+
+## Questions?
+
+Feel free to:
+- Open an issue for questions
+- Check existing issues and discussions
+- Reach out to maintainers
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the GPL-3.0 License.