docs: add design spec for change detection and conflict resolution#9
Open
sumedhdk22 wants to merge 7 commits into
Open
docs: add design spec for change detection and conflict resolution#9sumedhdk22 wants to merge 7 commits into
sumedhdk22 wants to merge 7 commits into
Conversation
389b767 to
f5171d4
Compare
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
sapank-sys
reviewed
May 26, 2026
nikhilk
reviewed
May 27, 2026
nikhilk
reviewed
May 27, 2026
nikhilk
reviewed
May 27, 2026
nikhilk
requested changes
May 27, 2026
Collaborator
|
Nit -- could you please move this to docs/features/checksum.md -- to keep the top-level directory somewhat clean. |
Contributor
Author
|
@nikhilk , I have updated the design with fine-grained change isolation. PTAL. |
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
ad168cd to
747b2aa
Compare
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
sapank-sys
reviewed
Jun 2, 2026
4827eeb to
c4b3637
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces the architectural design specification for local change detection and remote conflict resolution in the Metadata as Code tool (
kcmd).The proposed design balances performance, minimal remote network footprint, and workspace cleanliness while ensuring local changes are safely synchronized without data loss.
Key Proposals & Architecture Details
.catalog_state.json): Recommends a single, flat, system-managed JSON state database at the workspace root (Option A) over directory-mirroring or co-located checksum files to maximize Node.js native parsing speed and minimize clutter.Safe to Pull,Safe to Delete Locally,Safe to Push,Safe to Delete Remotely,Safe to Create) for all combinations of local, remote, and missing aspect states.--dry-run) Mechanics: Fully specifies the pull/push dry-run workflows to safely preview local workspace modifications or remote mutation sequences without executing actual disk writes or remote API mutations.