Contributing to Replay

Thanks for your interest in contributing!

Getting Started

Fork the repository on GitHub
Clone your fork
Run make deps to install dependencies
Run make build to verify the build

Development Workflow

Create a feature branch from main
Write tests for new functionality
Run make test and make vet before submitting
Keep commits small and focused
Use conventional commit messages (feat:, fix:, chore:, docs:)

Running Tests

# All tests
make test

# With race detection
make test-race

# Lint and vet
make lint
make vet

Running Examples Locally

Start the required services:

docker compose up -d

Then run the workflows:

replay run examples/test.yaml
replay run examples/phase2-vars.yaml
replay run examples/linkedin-demo.yaml

Code Style

Follow standard Go conventions (gofmt, go vet, staticcheck)
Avoid external dependencies where possible
Public API changes should be discussed in an issue first
Keep the YAML DSL backward-compatible — prefer additive changes

Pull Request Process

Update documentation if needed
Ensure CI passes (lint, vet, build, test)
Request a review
Squash commits on merge

Areas for Contribution

New step types — gRPC, GraphQL, message queue consumers
Assertion operators — regex, custom functions
Output formats — JUnit XML, JSON report
Integrations — Slack notifications, Jira issue creation
Plugins — Replay’s architecture supports a plugin system
Documentation — More examples, tutorials, video walkthroughs

Reporting Issues

Open an issue with:

A clear description of the problem
Steps to reproduce (include the workflow YAML)
Expected vs actual behaviour
Go version and OS

Troubleshooting

⌘I