LDS / template

Library-Interface-Note.md

Describe a public library interface, consumers and compatibility.

DownloadView source file Read related standard See example

Useful when

Library changes are hard to communicate.

Choose your situation

What you should change

Replace APIs, versions, consumers and compatibility assumptions.

Use only the parts that help. These are starting points, not rigid requirements.

View resource

# {{LIBRARY_NAME}} Interface Note

## Public API Surface

{{PUBLIC_API_SUMMARY}}

## Stability Level

{{STABILITY_LEVEL}} — experimental | interface-stable | versioned | reference

## Versioning / Breaking-Change Policy

{{VERSIONING_POLICY}}

## Extension Contracts

{{EXTENSION_CONTRACTS}}

## Known Consumers

{{KNOWN_CONSUMERS}}

## Companion Crates

{{COMPANION_CRATES_AND_GOVERNING_STANDARDS}}

## Known Gaps

{{KNOWN_GAPS}}

Related resources

LDS / example / Quick win

Breaking-Change-Cycle.md

See an illustrative breaking change and migration cycle.

View & adapt Download