konrad/go-dns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add BIND TSIG guide and align project documentation

Browse Source 
Create bind-tsig-configuration.md for allow-update and allow-transfer
setup. Link from README and project spec; extend .gitignore for .env files.
Record implementation decisions for change C-00001-setup-project.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Konrad Neitzel
2026-07-04 14:27:03 +02:00
co-authored by Cursor
parent 47f17445d0
commit eff7637f86
6 changed files with 198 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/changes/00001-setup-project/impl-decisions.md
+41
View File
@@ -0,0 +1,41 @@
# Implementation decisions: Initial project setup and DNS operation catalog
## Context
- **Change folder:** `docs/changes/00001-setup-project/`
- **Branch:** `feature/C-00001-setup-project`
- **Scope:** Documentation and scaffolding only (no Go source)
## Decisions
| # | Area | Decision | Rationale |
|---|------|----------|-----------|
| 1 | Git baseline | Baseline commit pushed before implementation edits | Per `implement-change` skill and plan step 0 |
| 2 | BIND guide | Single `docs/bind-tsig-configuration.md` with all spec section 9 topics | Primary deliverable of this change |
| 3 | Example secret | Placeholder Base64 in guide (not a real key) | Illustration only; guide warns against committing secrets |
| 4 | `.gitignore` | Added `.env` and `.env.*` | Spec requirement 10; was missing from specify phase |
| 5 | Library code | No `doc.go` or placeholder `godns` package | Plan explicitly excludes `*.go`; first API change adds packages |
## Deviations from plan
- None.
## Follow-ups / risks
- **`go work sync` at workspace root** may fail if sibling module `log-analyzer` lacks `go.mod` (pre-existing workspace issue). AC-1 verification should use `go-dns/go.mod` directly or fix workspace separately.
- **Gitea repo** was available; baseline and feature branch push succeeded.
- **verify-agent:** Run full AC-1 through AC-10 checklist from `plan.md`.
- **Next change:** Implement `package godns` wire protocol (RFC 2136 UPDATE, AXFR, TSIG) per backlog/spec.
## Files touched
| Path | Action |
|------|--------|
| `docs/bind-tsig-configuration.md` | created |
| `docs/project-specification.md` | modified — live BIND guide links |
| `README.md` | modified — BIND guide link |
| `.gitignore` | modified — `.env` patterns |
| `.cursor/rules/project-specification.mdc` | modified — guide path wording |
| `docs/changes/00001-setup-project/impl-decisions.md` | created |
Git: `git init`, remote `origin`, branch `feature/C-00001-setup-project`, baseline commit `47f1744`.