tools/go-cuckoo
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Releases 4 Wiki Activity

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
+1 -1
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 9b5545bf52 - Show all commits
docs/adr/001_design_principles.md
+1 -1
View File
@@ -33,8 +33,8 @@ Do not equate them.
- [ ] Update the `README.md` and `doc.go` to reflect these principles. - [ ] Update the `README.md` and `doc.go` to reflect these principles.
- [ ] Update the contributing guide and pull request template to require these principles are met. - [ ] Update the contributing guide and pull request template to require these principles are met.
2. The repository should contain a living document, describing the interface differences between `go-cuckoo` and `map`. 2. The repository should contain a living document, describing the interface differences between `go-cuckoo` and `map`.
(I already started work on branch `docs/interface-congruency-analysis`.)
I should prioritize limiting any incongruencies. I should prioritize limiting any incongruencies.
(I already started work on branch `docs/interface-congruency-analysis`.)
- [ ] Produce the first draft to uncover any current incongruencies. - [ ] Produce the first draft to uncover any current incongruencies.
- [ ] Link the document to the `README.md`. - [ ] Link the document to the `README.md`.
3. Analyze the familiarity of `go-cuckoo`'s current interface. 3. Analyze the familiarity of `go-cuckoo`'s current interface.