docs(adr): adr template, design principles adr #26

Merged

mvhutz merged 20 commits from docs/contract-v2 into main 2026-07-05 01:27:01 +00:00

Conversation 0 Commits 20 Files Changed 2

+61

mvhutz commented 2026-07-04 01:26:15 +00:00

Owner

Copy Link

Copy Source

Description

We need a more directed approach to go-cuckoo's interface.
This ADR proposes that direction.

Changes

• Add ADR template.
• Add "Adopt Parity and Consistency as Principles For go-cuckoo" ADR.

Design Decisions

• Put ADRs under docs/adr/, as that is common practice.

Checklist

• Tests pass
• Docs updated

## Description We need a more directed approach to `go-cuckoo`'s interface. This ADR proposes that direction. ## Changes - Add ADR template. - Add "Adopt Parity and Consistency as Principles For `go-cuckoo`" ADR. ## Design Decisions - Put ADRs under `docs/adr/`, as that is common practice. ## Checklist - [x] Tests pass - [x] Docs updated

mvhutz added 11 commits 2026-07-04 01:26:15 +00:00

feat: current contract list, started similarity 4464af781a

fix: wording f18d48a3c2

docs: finished congruency, started target state a72146ca9c

docs: insert, copy cddc205fe8

docs: DeleteFunc, Collect 5c84ed7794

docs: congruency target bd25bb69bd

feat: progress up to this point 3aa5be87f2

Merge remote-tracking branch 'origin' into docs/contract-v2 bfe2f152e1

feat: adr for design principles, template 56096bd83f

style: worded consequences more as a checklist 7bc42e7101

revert: no old adr 3f77e230a1

mvhutz added 1 commit 2026-07-04 01:28:53 +00:00

chore: move to docs/adr df5a25d349

mvhutz added 1 commit 2026-07-04 01:30:25 +00:00

style: no number in ADR title b96d47fa1b

mvhutz added 1 commit 2026-07-04 01:41:31 +00:00

style: capitalization in status for adr template 00ed7c8888

mvhutz added 1 commit 2026-07-04 23:46:26 +00:00

docs: add link to branch with previous work 3bc9d63b93

mvhutz added 1 commit 2026-07-04 23:48:19 +00:00

style: reordered second consequence 9b5545bf52

mvhutz added 1 commit 2026-07-05 00:01:23 +00:00

docs: articulate core functionality 0b3223b916

mvhutz added 1 commit 2026-07-05 00:03:47 +00:00

fix: exemplify differences between map and go-cuckoo table 8720204298

mvhutz added 1 commit 2026-07-05 01:19:15 +00:00

docs: rename principles ot match more fundamental principles 7b0f016833

mvhutz added 1 commit 2026-07-05 01:22:30 +00:00

revert: no agents.md in this pr 192ca9d853

mvhutz merged commit 3e7acb2b51 into main 2026-07-05 01:27:01 +00:00

mvhutz deleted branch docs/contract-v2 2026-07-05 01:27:01 +00:00

mvhutz referenced this issue from a commit 2026-07-05 01:27:02 +00:00

docs(adr): adr template, design principles adr (#26)

mvhutz referenced this pull request 2026-07-05 01:32:59 +00:00

Write XP Report on Current Contract. #13

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something is not working

duplicate

This issue or pull request already exists

enhancement

New feature

help wanted

Need some help

invalid

Something is wrong

question

More information is needed

wontfix

This won't be fixed

No Label

Milestone

No items

No Milestone

Assignees

Clear assignees

mvhutz (Maxim Hutz)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: tools/go-cuckoo#26