Skip to content

docs(tips): add Compatibility section to TIP template #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jenpaff merged 2 commits into from
May 13, 2026
+6 −2
Merged

docs(tips): add Compatibility section to TIP template #402

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f110c3
docs(tips): add Compatibility section to TIP template
max-digi May 13, 2026
eba788e
Reorder: place Compatibility before Invariants
max-digi May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/pages/protocol/tips/_tip_template.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,12 @@ For features that do not introduce a precompile, this section should define the

Where a feature involves multiple processes, state diagrams / flowcharts should be considered when helpful.

# Invariants
# Compatibility
Comment thread
jenpaff marked this conversation as resolved.

Describe the impact of this TIP on external systems (indexers, market makers, analytics, wallets, tooling, etc.) and on existing on-chain state, events, or interfaces. Call out any breaking changes and the rules external systems must adopt to remain compatible.

This section should describe invariants that must always hold, and outline the critical cases that the test suite must cover.
If this TIP has no external compatibility impact, write `N/A`.

# Invariants

This section should describe invariants that must always hold, and outline the critical cases that the test suite must cover.
Loading