Quality: Cargo profiles + REVIEW.md

Merged
RM
3mo ago
+143-0

User description

Closes #10

Summary

  • Explicit workspace Cargo profiles: dev, test, bench, release (thin LTO, strip, panic=abort on release)
  • New root REVIEW.md quality checklist (toolchain, commands, domain checks, secrets, release policy)
  • Link from AGENTS.md; CI release-profile build smoke for telemetry-collector

Test plan

  • cargo fmt --all -- --check
  • cargo clippy --workspace --all-targets --locked -- -D warnings
  • cargo test --workspace --locked
  • cargo build -p telemetry-collector --release --locked

Linear: RM-357

Co-authored-by: Grok noreply@x.ai

CodeAnt-AI Description

Add release build safeguards and a workspace quality checklist

What Changed

  • Release builds for the telemetry collector now use thin LTO, symbol stripping, a single codegen unit, and abort-on-panic behavior for a smaller production binary.
  • CI now verifies that the telemetry collector builds successfully with the release configuration.
  • Added a pre-merge and pre-release checklist covering required checks, domain rules, secret handling, release policy, and known non-goals.
  • The local verification instructions now include the release build and link to the full checklist.

Impact

✅ Smaller production collector binaries
✅ Release build failures caught in CI
✅ Clearer pre-release quality and safety checks

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by cubic

Adds explicit Cargo profiles and a root quality checklist to standardize builds and reviews, plus a CI release-build smoke for telemetry-collector. Release now keeps panic behavior as unwind (was abort) so ProcessGovernor::Drop can resume tracked miners on panic. Satisfies Linear RM-357.

  • Workspace profiles: dev, test, bench, release tuned with thin LTO, single CGU, and symbol stripping; release uses panic=unwind to ensure miner resume on faults (slightly larger binary/backtraces are acceptable).
  • New REVIEW.md: toolchain, required commands, domain checks, secrets policy, and release/version guidance.
  • CI: adds cargo build -p telemetry-collector --release --locked smoke.
  • AGENTS.md: links to REVIEW.md and includes the locked release-build command.
  • Docs: require --locked on release verify commands; fix the Commands anchor.