Thank you for your interest in contributing to fstr! This document provides guidelines and instructions for contributing.
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/fstr.git - Create a branch:
git checkout -b feature/your-feature-name
- Go 1.19 or later
- golangci-lint (for linting)
go test -v -race ./...go test -bench=. -benchmem ./...golangci-lint run- Update documentation if needed
- Add tests for new features
- Ensure all tests pass and linting is clean
- Update CHANGELOG.md with your changes
- Submit a pull request
- Follow standard Go formatting (gofmt)
- Add comments for exported functions and types
- Include examples in documentation
- Keep functions focused and small
- Write descriptive commit messages
- Use the issue tracker
- Include Go version and OS
- Provide minimal reproduction steps
- Include error messages and stack traces
By contributing, you agree that your contributions will be licensed under the MIT License.