Contributing¶
Thank you for your interest in contributing! This document provides guidelines for contributing to the project.
Reporting Bugs¶
- Check existing issues to avoid duplicates.
- Open a new issue with a clear title and description.
- Include Go version, OS, and a minimal reproducing example.
Suggesting Improvements¶
- Open an issue describing the improvement and its motivation.
- For significant changes, discuss the approach before submitting a PR.
Development Setup¶
- Go 1.24+ — https://go.dev/dl/
- golangci-lint — https://golangci-lint.run/welcome/install/
- make — for running targets
Code Style¶
- Format with
gofmtandgoimports. - Run
make lintbefore committing. - Follow existing code conventions in the project.
Pull Request Process¶
- Fork the repository and create a feature branch.
- Make your changes with clear commit messages.
- Ensure
make testandmake lintpass. - Submit a PR against the
mainbranch. - Describe what the PR does and link any related issues.
License¶
By contributing, you agree that your contributions will be licensed under the MIT License.