Development

.github/CI_BADGES.md

@@ -0,0 +1,65 @@
+# CI/CD Badges
+
+This document provides badge URLs for the RustQ CI/CD pipeline.
+
+## Available Badges
+
+### CI Status Badge
+Add this to your README.md to show the current CI status:
+
+```markdown
+[![CI](https://github.com/YOUR_USERNAME/rustq/actions/workflows/ci.yml/badge.svg)](https://github.com/YOUR_USERNAME/rustq/actions/workflows/ci.yml)
+```
+
+### Code Coverage Badge (Codecov)
+Once you've set up Codecov and added the `CODECOV_TOKEN` secret:
+
+```markdown
+[![codecov](https://codecov.io/gh/YOUR_USERNAME/rustq/branch/main/graph/badge.svg)](https://codecov.io/gh/YOUR_USERNAME/rustq)
+```
+
+### Security Audit Badge
+Shows the status of cargo-audit security scanning:
+
+```markdown
+[![Security Audit](https://github.com/YOUR_USERNAME/rustq/actions/workflows/ci.yml/badge.svg?job=security-audit)](https://github.com/YOUR_USERNAME/rustq/actions/workflows/ci.yml)
+```
+
+## Setup Instructions
+
+### Codecov Integration
+
+1. Sign up at [codecov.io](https://codecov.io) with your GitHub account
+2. Add your repository to Codecov
+3. Get your Codecov token from the repository settings
+4. Add the token as a GitHub secret:
+   - Go to your repository Settings → Secrets and variables → Actions
+   - Click "New repository secret"
+   - Name: `CODECOV_TOKEN`
+   - Value: Your Codecov token
+5. The coverage job will automatically upload coverage reports
+
+### Badge Customization
+
+Replace `YOUR_USERNAME` with your GitHub username or organization name in all badge URLs.
+
+## CI Pipeline Overview
+
+The CI pipeline includes the following jobs:
+
+1. **Format Check** - Ensures code is formatted with `cargo fmt`
+2. **Clippy Lint** - Runs `cargo clippy` with warnings as errors
+3. **Test Suite** - Runs tests on multiple OS (Ubuntu, macOS, Windows) and Rust versions (stable, beta, nightly)
+4. **Integration Tests** - Runs integration tests with Redis and PostgreSQL services
+5. **Security Audit** - Scans dependencies for known vulnerabilities using `cargo audit`
+6. **Code Coverage** - Generates test coverage reports using `cargo-tarpaulin`
+7. **Build Check** - Verifies release builds and documentation generation
+8. **CI Success** - Final gate that ensures all jobs passed
+
+## Matrix Testing
+
+The test suite runs on:
+- **Operating Systems**: Ubuntu, macOS, Windows
+- **Rust Versions**: stable, beta, nightly
+
+This ensures compatibility across different platforms and Rust toolchain versions.