https://github.com/ferror/contract-backward-compatibility
A simple library to decide if you break the backward compatibility for events
https://github.com/ferror/contract-backward-compatibility
Last synced: about 2 months ago
JSON representation
A simple library to decide if you break the backward compatibility for events
- Host: GitHub
- URL: https://github.com/ferror/contract-backward-compatibility
- Owner: Ferror
- Created: 2022-10-17T21:35:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-17T21:42:04.000Z (over 3 years ago)
- Last Synced: 2025-11-15T23:03:47.940Z (4 months ago)
- Size: 1000 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contract Backward Compatibility
A simple library to decide if you break the backward compatibility for events
## Goal
You have a multiple services that consume and produce number of messages. Each service has it's own repository. You would like to share the event's structure between them to make sure a change in event won't destroy your system and to not duplicate that much code around you codebase.
1. Each change in event is linted.
Adding new field won't be a issue, but it most definitely change the event version.
Changing field type will trigger compatibility issue.
Removing field will trigger compatibility issue.
Changing field name will trigger compatibility issue.