Commit Graph

5 Commits

Author SHA1 Message Date
e00e6fcb1b docs: add logo for project, expand readme (#7)
All checks were successful
CI / Makefile Lint (push) Successful in 22s
CI / Go Lint (push) Successful in 26s
CI / Markdown Lint (push) Successful in 9s
CI / Unit Tests (push) Successful in 21s
CI / Fuzz Tests (push) Successful in 53s
CI / Mutation Tests (push) Successful in 1m23s
Reviewed-on: #7
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-21 01:14:17 +00:00
2bfaede2d4 ci: add lint makefile job (#5)
All checks were successful
CI / Makefile Lint (push) Successful in 15s
CI / Go Lint (push) Successful in 19s
CI / Unit Tests (push) Successful in 32s
CI / Fuzz Tests (push) Successful in 46s
CI / Mutation Tests (push) Successful in 51s
Currently, there is no CI job to lint the Makefile. This adds one.

Reviewed-on: #5
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-19 00:24:25 +00:00
ece10585a5 style: restructure makefile (#4)
All checks were successful
CI / Unit Tests (push) Successful in 13s
CI / Go Lint (push) Successful in 17s
CI / Mutation Tests (push) Successful in 33s
CI / Fuzz Tests (push) Successful in 58s
Currently, the `Makefile` is not well structured, and does not follow best practices. With the help of [`checkmake`](https://github.com/checkmake/checkmake), the Makefile can be forced to follow them.

### Decisions

- Added CI job `lint-makefile`, which forces the Makefile to conform to standards.
- The `make help` was set as the default target. This is common practice in the industry.
- The `make help` uses `grep` | `awk` to create a command table from `##` comments after each target. It seems a bit icky, but it is something that Docker, Kubernetes, and Helm all do.

Reviewed-on: #4
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-19 00:14:54 +00:00
0017a33f12 ci: clean up workflow (#3)
All checks were successful
CI / Unit Tests (push) Successful in 35s
CI / Golang Lint (push) Successful in 1m1s
CI / Fuzz Tests (push) Successful in 1m18s
CI / Mutation Tests (push) Successful in 1m12s
## Description

The current CI workflow was auto-generated by Claude, and is really not intuitive. Fixing it up to make it work better.

- Add names for jobs in workflow.
- Rename workflow to `ci.yml`.
- Added `go mod tidy` as a tasks in the `lint` job.

### Decisions

- Chose not to use emojis for workflow or job names. While they look nice, they are unprofessional, and harder to `grep`.

Reviewed-on: #3
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-18 00:47:02 +00:00
717408239b chore: move from tools/dsa (#1)
Some checks failed
CI / lint (push) Successful in 51s
CI / unit-test (push) Failing after 25s
CI / fuzz-test (push) Successful in 1m1s
CI / mutation-test (push) Successful in 42s
Moved the implementation of this hash table from `tools/dsa` #1.

Reviewed-on: #1
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-17 01:22:42 +00:00