Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 870 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 870 Bytes

Contributing

Issues

File bugs and feature requests via GitHub Issues.

For security vulnerabilities, follow the Security Policy instead.

Pull Requests

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Ensure make lint and make test pass locally
  4. Use conventional commits: feat:, fix:, refactor:, docs:, test:
  5. Open a PR against main

Local development

# Build
make build

# Run tests
make test

# Run linter (requires golangci-lint)
make lint

# Dry-run release build (requires goreleaser)
make release-dry

Code style

  • Format with gofmt (enforced by CI)
  • All linter checks in .golangci.yml must pass
  • No bare print statements — the tool writes to os.Stdout / os.Stderr explicitly