Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 1.77 KB
Raw

Contributing to galloc

Thank you for your interest in contributing to galloc! This document provides guidelines for contributing to this project.

Prerequisites

  • Go 1.25+ -- matches gogpu ecosystem requirements
  • golangci-lint -- go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Building

go build ./...

Testing

# Unit tests
go test ./...

# With race detector (requires CGO_ENABLED=1)
CGO_ENABLED=1 go test -race ./...

# With coverage
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

Benchmarks

go test -bench=. -benchmem ./...

Fuzzing

go test -fuzz=FuzzAllocFree -fuzztime=30s

Code Style

  • Format with gofmt (enforced in CI)
  • Pass golangci-lint run --timeout=5m
  • Pass go vet ./...
  • Add comments for non-obvious logic -- explain WHY, not WHAT
  • All public types and functions must have doc comments
  • No unsafe -- this library is intentionally pure safe Go

Pull Requests

  1. Fork the repository and create a feature branch
  2. Use Conventional Commits for commit messages:
    • feat: new features
    • fix: bug fixes
    • perf: performance improvements
    • test: test additions/changes
    • docs: documentation
    • refactor: code restructuring
  3. Ensure all checks pass: go build ./... && go test ./... && golangci-lint run --timeout=5m
  4. Open a PR against main

AI-assisted contributions are welcome. For guidance on effective AI-assisted development practices, see the Smart Coding section in the wgpu CONTRIBUTING.md.

License

By contributing, you agree that your contributions will be licensed under the MIT License.