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

style: worded consequences more as a checklist

Browse Source
This commit is contained in:
Maxim Hutz
2026-07-03 21:21:50 -04:00
parent 56096bd83f
commit 7bc42e7101
2 changed files with 654 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
adr/001_design_principles.md
+11 -9
View File
@@ -30,13 +30,15 @@ Do not equate them.
## Consequences
1. The repository should support both design principles.
- The `README.md` and `doc.go` should reflect these principles.
- The contributing guide and pull request template should require 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.
2. The repository should contain a living document, describing the interface differences between `go-cuckoo` and `map`.
- Its construction should uncover any current incongruencies in the interfaces.
- I should prioritize limiting any incongruencies.
- The document should be visible from the `README.md`.
3. An analysis of the familiarity of `go-cuckoo`'s interface should be made.
- Unlike the analysis of congruency, this should be a one time document.
Familiarity is implicit to users, and does not need to be referenced.
But, any rationale should be documented in commit messages, or future ADRs.
I should prioritize limiting any incongruencies.
- [ ] Produce the first draft to uncover any current incongruencies.
- [ ] Link the document to the `README.md`.
3. Analyze the familiarity of `go-cuckoo`'s current interface.
Unlike the analysis of congruency, this should be a one time document.
Familiarity is implicit to users, and does not need to be referenced.
But, any rationale should be documented in commit messages, or future ADRs.
- [ ] Produce the analysis document.
- [ ] Resolve any issues found.