Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (41 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 1.04 KB

Contributing guide

Building from Source

# Build the binary
make docker-mcp

# Cross-compile for all platforms
make docker-mcp-cross

# Run tests
make test

Code Quality

# Format code
make format

# Run linter
make lint

Testing

Running Tests

# Run all unit tests
make test

# Run integration tests
make integration

Unit Test Coverage

# Generate HTML coverage report for ALL packages in one view
go test -cover -coverprofile=coverage.out ./... -short
go tool cover -html=coverage.out -o coverage.html && open coverage.html

Open a Pull Request

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests and linting (make unit-tests lint)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Code of Conduct

This project follows a Code of Conduct. Please review it in CODE_OF_CONDUCT.md.