change-safety

Review code changes for compatibility risks and security implications before merging.

2|Updated May 18, 2022
One-click install
npx skills add https://github.com/alexfalkowski/bin --skill change-safety
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: change-safety
Source: https://github.com/alexfalkowski/bin/tree/main/skills/change-safety
Command: npx skills add https://github.com/alexfalkowski/bin --skill change-safety

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill prevents accidental breakage of user-facing interfaces, documented APIs, and critical system configurations during the development process.

Core Features & Use Cases

  • Compatibility Guardrails: Ensures that changes to commands, flags, environment variables, and Make targets do not silently break downstream consumers.
  • Risk Analysis: Provides a structured framework for evaluating security, migration, and dependency impacts before applying changes.
  • Use Case: When refactoring a shared Makefile or updating a core CLI tool, use this skill to verify that the proposed changes maintain backward compatibility and include necessary migration documentation.

Quick Start

Use the change-safety skill to review the current branch for potential compatibility risks and security implications before merging.

Frequently Asked Questions about change-safety

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

FAQPage Schema
How do I ensure backward compatibility when refactoring shared Makefiles or core CLI tools?

To ensure backward compatibility, use a structured framework that verifies proposed changes to commands, flags, and Make targets do not silently break downstream consumers. This approach enforces rigorous compatibility guardrails and risk analysis before applying modifications.

What is the best way to evaluate security and dependency impacts before modifying an API?

The best way to evaluate security impacts is by applying a structured risk analysis framework that checks for migration and dependency issues. This ensures system stability by requiring explicit migration planning for all breaking changes before they are applied.

When do I need explicit migration planning for breaking changes in infrastructure updates?

You need explicit migration planning for breaking changes whenever modifying user-facing interfaces, documented APIs, or critical system configurations. This prevents accidental breakage by enforcing documented safety protocols and verifying downstream impact during infrastructure updates.

Does this compatibility checking approach work for environment variables and command flags?

Yes, this compatibility checking approach works for environment variables and command flags. It provides compatibility guardrails that specifically verify changes to these interface elements do not silently break downstream consumers during development.

What are the limitations of relying on manual code reviews for interface protection?

Manual code reviews often lack a structured framework for evaluating security, migration, and dependency impacts. Without enforced compatibility guardrails and explicit migration planning, accidental breakage of user-facing interfaces and documented APIs can easily occur.