code-review

Detects breaking renames and removals on customer-facing surfaces during pull request review.

3|Updated May 1, 2026
One-click install
npx skills add https://github.com/MaterializeInc/materialize-monitoring --skill code-review-materializeinc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-review
Source: https://github.com/MaterializeInc/materialize-monitoring/tree/main/.claude/skills/code-review
Command: npx skills add https://github.com/MaterializeInc/materialize-monitoring --skill code-review-materializeinc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Renames and removals of committed identifiers — alert names, Terraform variables, dashboard names, recording rules — silently break customer routing, plans, and links, and they slip through review because a rename reads as an edit rather than a removal. ## Core Features & Use Cases - Committed-surface detection: Flags renames and removals across alerts, recording rules, Terraform variables/outputs, dashboard identities, and metric tier keys that owe a 30-day deprecation cycle. - False-positive guardrails: Lists what is not a breakage — additions, query id changes, expression changes, dashboard internals — so the deprecation policy is not over-applied. - Alternative-first feedback: Suggests designs that avoid the cycle entirely, such as minting recording rules, keeping old identifiers working, or carrying severity in labels instead of names. - Use Case: While reviewing a PR that renames an alert from mz-mon-env-top to mz-mon-environment-overview, the reviewer catches the delete-plus-add pattern and asks for a **Deprecated:** bullet in the PR description with both names working for 30 days. ## Quick Start Review this pull request diff and flag any renames or removals on the customer-facing surface that owe a deprecation cycle.

Frequently Asked Questions about code-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a pull request for breaking changes to alerts and dashboards?

Check the diff for delete-plus-add pairs on committed identifiers: alert names, severity labels, recording rule names, Terraform variables and outputs, dashboard metadata names, and metric tier keys. A rename on any of these owes a 30-day deprecation cycle with both names working.

What counts as a breaking change in a monitoring repository?

Renames or removals of committed identifiers are breaking: alert names, record names, Terraform variables and outputs, dashboard metadata names, and tier keys. Additions, query id changes, expression changes under a stable record name, and dashboard internals are not breaking.

Does changing an alert expression require a deprecation cycle?

No. A behavior change to an alert's expression, for-duration, or thresholds owes no deprecation cycle as long as the name stays. It is still worth a release-note comment since customer routing and runbooks key on the name.

Should I ask authors to update CHANGELOG.md in a pull request?

No. CHANGELOG.md is generated by the propose-bumps automation on every merge, so hand-written entries are overwritten. Ask for a Deprecated or Removed bullet in the PR description under Release Notes instead.

How can a rename avoid the deprecation cycle entirely?

Add the new identifier while keeping the old one working, since additions are free and the cycle only starts when the old identifier is removed. For Terraform variables, retain the old variable and let the new one take precedence.