42 lines (36 loc) · 1.39 KB

Contributing

Thank you for your interest in contributing!

Requirements

Go Version: 1.26 or higher is required.
Tools: golangci-lint and task (Taskfile.dev) are recommended.

Development Workflow

Setup: Initialise submodules before building locally. internal/metal/ forwards C++ sources from lib/mlx and lib/mlx-c with __has_include guards, and missing submodules intentionally fail fast at compile time. CI mirrors this with recursive submodule checkout.
```
git submodule update --init --recursive
```
Testing: Ensure all tests pass before submitting changes.
```
go test ./...
```
Code Style: All code must follow standard Go formatting.
```
gofmt -w .
go vet ./...
```
Linting: We use golangci-lint to maintain code quality.
```
golangci-lint run ./...
```

Commit Message Format

We follow the Conventional Commits specification:

feat: A new feature
fix: A bug fix
docs: Documentation changes
refactor: A code change that neither fixes a bug nor adds a feature
chore: Changes to the build process or auxiliary tools and libraries

Example: feat: add new endpoint for health check

License

By contributing to this project, you agree that your contributions will be licensed under the European Union Public Licence (EUPL-1.2).