mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-24 13:16:28 +00:00
docs: add architecture migration guardrails (#3253)
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# Compatibility Cleanup Register
|
||||
|
||||
Use this file to track temporary compatibility code introduced by architecture
|
||||
migration PRs. Entries are required only for compatibility paths that are planned
|
||||
for later deletion.
|
||||
|
||||
## Required Source Marker
|
||||
|
||||
```rust
|
||||
// RUSTFS_COMPAT_TODO(<task-id>): <why this compatibility path exists>. Remove after <specific condition>.
|
||||
```
|
||||
|
||||
## Open Items
|
||||
|
||||
No compatibility code has been introduced in this branch.
|
||||
|
||||
## Review Checklist
|
||||
|
||||
Before completing a PR that adds wrappers, re-exports, fallbacks, legacy action
|
||||
mappings, or old endpoint compatibility layers:
|
||||
|
||||
- [ ] The source has a `RUSTFS_COMPAT_TODO(<task-id>)` marker.
|
||||
- [ ] This register has a matching entry.
|
||||
- [ ] The entry states why compatibility is needed.
|
||||
- [ ] The entry states the exact removal condition.
|
||||
- [ ] The cleanup is not bundled with new migration logic.
|
||||
Reference in New Issue
Block a user