Contributing Overview

​

Welcome Contributors

​

Code of Conduct

​

How to Contribute

​

Reporting Issues

1. Check existing issues to avoid duplicates
2. Create a new issue with a clear title and description
3. Include reproduction steps for bugs
4. For features, explain the use case and benefits

​

Pull Request Process

1. Fork and clone the repository:
   git clone https://github.com/jarfernandez/check-image.git
   cd check-image
   
2. Create a feature branch:
   git checkout -b feat/your-feature-name
   
3. Make your changes following the project guidelines
4. Install pre-commit hooks:
   brew install pre-commit golangci-lint
   pre-commit install
   pre-commit install --hook-type commit-msg
   
5. Run tests and checks:
   go test ./...
   pre-commit run --all-files
   
6. Commit using Conventional Commits:
   git commit -m "feat: Add new validation check"
   
7. Push and create a pull request:
   git push origin feat/your-feature-name
   gh pr create --title "feat: Add new validation check" --body "Description of changes"
   

​

PR Requirements

• PR title must follow Conventional Commits format
• Title must start with uppercase letter after the prefix
• All CI checks must pass (tests, linting, build)
• Code must include tests with good coverage
• Documentation must be updated (README.md and CLAUDE.md)

​

Commit Message Format

<type>: <description>

[optional body]

[optional footer]

• feat: New feature (triggers minor version bump)
• fix: Bug fix (triggers patch version bump)
• docs: Documentation changes (no release)
• refactor: Code refactoring (triggers patch version bump)
• test: Test updates (no release)
• chore: Maintenance tasks (no release)
• perf: Performance improvements (triggers patch version bump)
• ci: CI/CD changes (no release)
• build: Build system changes (no release)
• revert: Revert previous commit

git commit -m "feat: Add support for OCI archives"
git commit -m "fix: Handle missing environment variables"
git commit -m "docs: Update installation instructions"
git commit -m "refactor: Simplify error handling in imageutil"

​

Development Workflow

​

GitHub CLI

# Create an issue
gh issue create --title "bug: Image parsing fails" --body "Description"

# Create a pull request
gh pr create --title "feat: Add new check" --body "Implementation details"

# View PR checks
gh pr checks

​

Branch Strategy

• Never commit directly to main
• Always create a feature branch
• Use descriptive branch names: feat/platform-validation, fix/auth-error
• Delete branches after merging

​

What Gets Checked

• Trailing whitespace, EOF newlines, line endings
• YAML and JSON syntax validation
• gofmt formatting
• go mod tidy
• go vet analysis
• golangci-lint (see .golangci.yml for rules)
• go test with race detection
• Commit message format validation

• gosec security scanning (doesn’t block commits)

​

Documentation Requirements

​

CLAUDE.md

• Design decisions and trade-offs
• Implementation details
• Flag names, struct definitions
• Integration points

​

README.md

• Command usage and examples
• Flag descriptions
• Configuration file formats
• Expected behavior

​

Getting Help

• Check existing documentation and issues
• Ask questions in your PR or issue
• Review CLAUDE.md for architectural guidance
• Look at similar existing features for patterns

​

Next Steps