Contributing¶

How to contribute to redisctl.

Getting Started¶

Prerequisites¶

Rust 1.75+ (edition 2024)
Git

Clone and Build¶

git clone https://github.com/redis-developer/redisctl
cd redisctl
cargo build

Run Tests¶

cargo test --workspace --all-features

Run Lints¶

cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings

Development Workflow¶

1. Create a Branch¶

git checkout -b feat/my-feature
# or
git checkout -b fix/my-fix

Branch prefixes: - feat/ - New features - fix/ - Bug fixes - docs/ - Documentation - refactor/ - Code refactoring - test/ - Test improvements

2. Make Changes¶

Follow the existing code style. Key patterns:

Use anyhow for CLI errors, thiserror for library errors
All commands must support -o json output
Add tests for new functionality

3. Test Locally¶

# Run all tests
cargo test --workspace --all-features

# Run specific test
cargo test test_database_list

# Run with output
cargo test -- --nocapture

4. Commit¶

Use conventional commits:

git commit -m "feat: add database backup command"
git commit -m "fix: handle empty response in subscription list"
git commit -m "docs: add VPC peering guide"

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

5. Push and Create PR¶

git push origin feat/my-feature

Then create a PR on GitHub.

Project Structure¶

crates/
├── redis-cloud/         # Cloud API client
│   ├── src/handlers/    # API endpoint handlers
│   └── tests/           # Integration tests
├── redis-enterprise/    # Enterprise API client
│   ├── src/handlers/    # API endpoint handlers
│   └── tests/           # Integration tests
└── redisctl/           # CLI
    ├── src/commands/   # Command implementations
    ├── src/workflows/  # Multi-step workflows
    └── tests/          # CLI tests

Adding a New Command¶

Add command enum in crates/redisctl/src/cli.rs
Implement handler in src/commands/
Add to command routing in src/main.rs
Add tests in tests/
Update documentation

Testing¶

Unit Tests¶

#[test]
fn test_parse_database_id() {
    let id = parse_database_id("123:456").unwrap();
    assert_eq!(id.subscription, 123);
    assert_eq!(id.database, 456);
}

Integration Tests with Mocks¶

#[tokio::test]
async fn test_database_list() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/subscriptions/123/databases"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!([
            {"databaseId": 1, "name": "test"}
        ])))
        .mount(&mock_server)
        .await;

    // Test against mock
}

Documentation¶

User docs: mkdocs-site/docs/
API docs: Inline rustdoc comments
Build docs: cargo doc --workspace