๐ ๏ธ Contributing to EasyCache
August 19, 2026 ยท View on GitHub
Thank you for your interest in contributing to EasyCache! ๐
We welcome all contributions, whether it's bug reports, feature requests, or pull requests.
๐ Reporting Issues
If you found a bug or have a question, please open an Issue.
Make sure to include:
โ
A clear description of the problem.
โ
Steps to reproduce the issue (if applicable).
โ
Your Go version and system details.
Before opening a new issue, check if it hasn't been reported already.
๐ก Requesting a Feature
We love new ideas! ๐ If you have a suggestion, open an Issue with:
โ
A detailed explanation of the feature.
โ
Why this feature is useful.
โ
Example use cases.
๐ Submitting a Pull Request (PR)
โ
Open your pull request against main.
โ
Create a Pull Request with a clear description of your changes.
๐งช Running Tests & Benchmarks
Before submitting code, ensure all tests pass:
go test ./... -v
go test -race ./...
go vet ./...
go test -coverpkg=./... -coverprofile=/tmp/easycache.cover ./...
go tool cover -func=/tmp/easycache.cover
๐ Performance Benchmarks
Run benchmarks locally when evaluating performance-sensitive changes:
go test -run '^$' -bench=. -benchmem ./tests
๐ฏ Contributing Best Practices
โ
Be respectful โ We welcome contributions from everyone!
โ
Keep discussions focused โ Avoid unrelated topics in issues/PRs.
โ
Improve documentation โ Even small fixes help!
โ
Test your code โ Ensure everything works before submitting.