convention-hyrums-law
CommunityAvoid breaking users with implicit API contracts.
Software Engineering#backward-compatibility#design-principles#software-engineering#api-design#hyrums-law#implicit-contracts
AuthorsunLeee
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Hyrum's Law describes how, with enough observers, users come to rely on observed behavior even if it isn't officially documented. This Skill helps teams recognize and mitigate such risks by encouraging explicit contracts and stable interfaces.
Core Features & Use Cases
- Understand the risk of hidden dependencies in APIs.
- Provide design patterns for explicit versioning, error handling, and contract clarity.
- Use cases include evolving public interfaces without breaking downstream clients and guiding API deprecation strategies.
Quick Start
Audit your API surfaces to document explicit contracts and migrate toward stable, documented behavior.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: convention-hyrums-law Download link: https://github.com/sunLeee/optimization/archive/main.zip#convention-hyrums-law Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.