docs(adr): adr template, design principles adr (#26)
CI / Check PR Title (push) Has been skipped
CI / Makefile Lint (push) Successful in 1m21s
CI / Go Lint (push) Successful in 1m33s
CI / Unit Tests (push) Successful in 1m18s
CI / Fuzz Tests (push) Successful in 1m55s
CI / Mutation Tests (push) Successful in 1m41s
CI / Markdown Lint (push) Successful in 57s

## Description

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

## Changes

- Add ADR template.
- Add "Adopt Congruent and Familiar Design For `go-cuckoo`" ADR.

## Design Decisions

- ~~Put ADRs under `adr/` for more. Because we don't realy have any docs right now, it doesn't make much sense to nest it.~~

## Checklist

- [x] Tests pass
- [x] Docs updated

Reviewed-on: #26
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
This commit was merged in pull request #26.
This commit is contained in:
2026-07-05 01:27:00 +00:00
committed by Maxim Hutz
parent 05dbda496a
commit 3e7acb2b51
2 changed files with 61 additions and 0 deletions
+15
View File
@@ -0,0 +1,15 @@
# Title
**Status**: <!-- Proposed, accepted, rejected, etc... -->
## Context
<!-- What is the issue that we're seeing that is motivating this decision or change? -->
## Decision
<!-- What is the change that we're proposing and/or doing? -->
## Consequences
<!-- What becomes easier or more difficult to do because of this change? -->