๐Ÿ› ๏ธ 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.