Contributing

We treat this repo as "Open Source" within Redis: anyone who clears the bar below is welcome to contribute.

Local setup

git clone git@github.com:redis-performance/serverless-cache-benchmark.git
cd serverless-cache-benchmark
go mod download
make build

This produces a serverless-cache-benchmark binary in the current directory. Go 1.24 or later is required.

Branch naming

<type>/<short-description>

Types: feat, fix, refactor, test, docs, chore

Example: feat/add-cloudwatch-metrics

Coding standards

• Keep changes focused; one logical change per PR.
• Follow the conventions already present in the codebase (formatting, naming, error handling).
• No dead code, no commented-out blocks.
• Run make checkfmt (wraps gofmt) before pushing; CI will reject unformatted code.

Submitting changes

1. Fork or create a branch from main.
2. Make your changes with clear, atomic commits.
3. Open a pull request against main with a descriptive title and summary.
4. Address review comments promptly; force-push to the same branch to update.

Testing

• All new behaviour must be covered by tests.
• Existing tests must pass: run the test suite locally before opening a PR.
• Coverage should not decrease.

Run the full test suite with:

make test

This command downloads dependencies, builds an instrumented binary, runs all Go tests with coverage enabled, and prints a coverage summary.

Quick smoke-test against a local Redis instance before opening a PR:

./serverless-cache-benchmark run --cache-type redis --redis-uri redis://localhost:6379 --clients 4 --test-time 10

Review process

• At least one maintainer approval is required before merge.
• CI must be green.
• Maintainers may request changes or close PRs that do not meet the bar — this is normal and not personal.