Thank you for your interest in contributing to this project! This document provides guidelines and steps for contributing.
Contributors are expected to maintain a respectful and inclusive environment for everyone involved in the project.
- Fork and clone the repository
- Install Go 1.21 or later
- Install golangci-lint for code linting
- Run tests:
go test ./...
- Fork this repository to your account
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes and test them:
- Run
go test ./... - Run
go build ./...
- Run
- Commit your changes following conventional commits
- Push to your branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Ensure all tests pass
- Add tests for new functionality
- Update documentation as needed
- Follow Go coding conventions
- Format your code with
gofmt - Ensure all linting checks pass
- Write clear commit messages
- Search for existing issues first
- Provide clear reproduction steps
- Include relevant versions and environment details
Feel free to ask questions by creating an issue or starting a discussion.
For detailed information about creating pull requests, see the Github documentation.