Skip to content

docs: state no-breaking-API-changes policy#50

Merged
serradura merged 1 commit into
mainfrom
docs/no-breaking-changes-policy
May 26, 2026
Merged

docs: state no-breaking-API-changes policy#50
serradura merged 1 commit into
mainfrom
docs/no-breaking-changes-policy

Conversation

@serradura
Copy link
Copy Markdown
Member

@serradura serradura commented May 26, 2026

Summary

  • Encode the same stability compromise as u-case into u-attributes: because u-attributes is a runtime dependency of u-case (whose public API is frozen), its own public API and runtime contracts are frozen too.
  • Add a Golden rule: no breaking API changes — ever section at the top of CLAUDE.md so AI assistants working in the repo treat this as load-bearing — propose backward-compatible paths or surface conflicts rather than ship a break.
  • Add an > [!IMPORTANT] callout at the top of README.md (parallel to the one on u-case) so the stance is visible to direct readers as well.

Major version bumps remain reserved for dependency-floor changes (Ruby / activemodel) per SemVer; no behavior breaks.

Test plan

  • Docs-only change — no code or tests touched
  • Skim the rendered README on GitHub to confirm the [!IMPORTANT] callout renders correctly

🤖 Generated with Claude Code

Encode the same stability compromise as u-case: u-attributes is a
runtime dependency of u-case, so its public API and runtime contracts
are frozen too. Document it as the Golden rule in CLAUDE.md and as an
IMPORTANT callout at the top of README.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@serradura serradura self-assigned this May 26, 2026
@serradura serradura added this to the 3.x milestone May 26, 2026
@serradura serradura merged commit 8fa58fd into main May 26, 2026
8 checks passed
@serradura serradura deleted the docs/no-breaking-changes-policy branch May 26, 2026 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant