Merge pull request #28 from DoDAON/feat/go-profile

feat: add Go profile with fixture and smoke test

Author: baskduf

README.md

@@ -17,6 +17,7 @@
   <img alt="FastAPI" src="https://img.shields.io/badge/FastAPI-009688?style=flat-square&logo=fastapi&logoColor=white" />
   <img alt="Spring Boot" src="https://img.shields.io/badge/Spring_Boot-6DB33F?style=flat-square&logo=springboot&logoColor=white" />
   <img alt="Android" src="https://img.shields.io/badge/Android-3DDC84?style=flat-square&logo=android&logoColor=white" />
+  <img alt="Go" src="https://img.shields.io/badge/Go-00ADD8?style=flat-square&logo=go&logoColor=white" />
   <img alt="Contributors" src="https://img.shields.io/github/contributors/baskduf/harness-starter-kit?style=flat-square" />
 </p>
 

docs/profiles.md

@@ -18,6 +18,7 @@ Available profiles:
 - `android`
 - `react`
 - `vue`
+- `go`
 
 ## How Agents Use Profiles
 

docs/validation.md

@@ -44,6 +44,7 @@ Automated fixture smoke tests cover harness installation for:
 - Spring Boot
 - Android / Kotlin Gradle
 - Vue
+- Go
 
 These tests verify that the installer preserves existing files, writes expected
 profile snippets, and produces runnable generic drift checks.

scripts/apply_harness.py

@@ -71,6 +71,7 @@ def parse_args() -> argparse.Namespace:
             "fastapi",
             "react",
             "vue",
+            "go",
         ),
         default="generic",
         help="Optional stack profile. Profiles add reference snippets only.",

scripts/check_docs_drift.py

@@ -50,6 +50,8 @@
     "out/",
     "target",
     "target/",
+    "vendor",
+    "vendor/",
     "target-repo/harness-starter-kit",
     "scripts/check_harness.py",
     "tsconfig.tsbuildinfo",

templates/generic/scripts/check_docs_drift.py

@@ -50,6 +50,8 @@
     "out/",
     "target",
     "target/",
+    "vendor",
+    "vendor/",
     "target-repo/harness-starter-kit",
     "scripts/check_harness.py",
     "tsconfig.tsbuildinfo",

templates/profiles/go/README.md

@@ -0,0 +1,74 @@
+# Go Harness Profile
+
+Use these snippets when the target project is a Go module or service.
+
+These files are agent reference material, not automatic transformations. Merge
+only the pieces that fit the target project's existing tools.
+
+Apply this profile by priority: always preserve the target module path, generated
+file boundaries, and exact local check commands; document database, auth, or
+external API setup when present; consider decision records only when changing
+module boundaries, persistence approach, auth flow, or external integration
+policy; use a short report/check note for narrow fixes.
+
+## Recommended Checks
+
+- `go build ./...` to verify the module compiles.
+- `go vet ./...` for static analysis included in the Go toolchain.
+- `golangci-lint run` when the target project has `.golangci.yml`,
+  `.golangci.yaml`, or `.golangci.toml`. Do not add golangci-lint if it is absent.
+- `go test ./...` for unit tests. Add `-count=1` to disable test result caching
+  when the results must reflect the current state.
+- `scripts/check_docs_drift.py` for stale documentation references.
+- `scripts/check_structure.py` for temporary or drift-prone files.
+
+## Generated Files
+
+Go projects often include code generated by tools such as `sqlc`, `protoc`,
+`mockgen`, `stringer`, `templ`, or similar. These files are source: do not
+edit them directly and do not omit them from version control unless the
+target project policy says otherwise. Record generated paths in `AGENTS.md`
+so agents know not to edit them.
+
+If the target project has a code generation step, document the command in
+`AGENTS.md` so agents can regenerate when the schema or interface changes.
+
+## Suggested Check Script
+
+Copy or adapt `check_harness.py` into the target repository's `scripts/`
+directory when the project has no existing task runner. It runs `go vet`,
+`golangci-lint` when the target has a golangci-lint config, and the generic
+drift checks.
+
+## Profile Absorption Notes
+
+When Go is introduced after generic adoption:
+
+- Merge relevant ignores from `gitignore.harness.txt`, especially build
+  outputs, vendor directories, and the local `harness-starter-kit/` clone.
+- Copy or adapt `check_harness.py` into `scripts/` only when the target has no
+  equivalent local verification command.
+- Update `AGENTS.md` with the module path, package layout conventions,
+  generated file paths, and completion checks.
+- Update `docs/conventions/coding.md` with package boundaries, error handling,
+  interface definition placement, testing approach, and any project-specific
+  patterns agents should repeat.
+- Consider a decision record when changing or selecting the module structure,
+  persistence layer, auth approach, external integration policy, or code
+  generation tooling. When the task only follows the existing architecture or
+  makes a narrow fix, a final report or check note is enough.
+- In the final report, list which snippets were adopted, adapted, skipped, or
+  deferred.
+
+## Go Notes
+
+- Keep `go.mod` and `go.sum` as source. Do not edit `go.sum` manually.
+- Use `go mod tidy` after adding or removing dependencies.
+- Do not commit build output binaries or the local `harness-starter-kit/` clone.
+- Add `vendor/` to `.gitignore` unless the target project intentionally vendors
+  dependencies.
+- Protect generated file directories in `AGENTS.md` so agents do not overwrite
+  them by hand.
+- Prefer table-driven tests with `t.Run` for cases that share setup.
+- Add integration or end-to-end tests only when the target project already has
+  a test database, container, or emulator setup in place.

templates/profiles/go/check_harness.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+"""Run local harness checks for a Go project."""
+
+from __future__ import annotations
+
+import argparse
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+
+def repo_root() -> Path:
+    current = Path(__file__).resolve()
+    if current.parent.name == "scripts":
+        return current.parents[1]
+
+    cwd = Path.cwd()
+    if (cwd / "scripts" / "check_docs_drift.py").exists():
+        return cwd
+
+    for candidate in (current.parent, *current.parents):
+        if (candidate / "go.mod").exists():
+            return candidate
+    return cwd
+
+
+ROOT = repo_root()
+
+
+def run(command: list[str]) -> None:
+    subprocess.run(command, cwd=ROOT, check=True)
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description="Run Go harness checks.")
+    parser.add_argument(
+        "--skip-tests",
+        action="store_true",
+        help="Run only vet and harness drift checks.",
+    )
+    args = parser.parse_args()
+
+    run(["go", "build", "./..."])
+    run(["go", "vet", "./..."])
+
+    lint_configs = (".golangci.yml", ".golangci.yaml", ".golangci.toml")
+    if shutil.which("golangci-lint") and any((ROOT / name).exists() for name in lint_configs):
+        run(["golangci-lint", "run"])
+
+    if not args.skip_tests:
+        run(["go", "test", "-count=1", "./..."])
+
+    run([sys.executable, "scripts/check_docs_drift.py"])
+    run([sys.executable, "scripts/check_structure.py"])
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

templates/profiles/go/gitignore.harness.txt

@@ -0,0 +1,15 @@
+# Go build outputs
+/bin/
+/dist/
+*.exe
+*.test
+*.out
+
+# Dependency vendor directory (omit this line if the project vendors intentionally)
+vendor/
+
+# Test cache
+/tmp/
+
+# Harness kit reference clone
+harness-starter-kit/

tests/fixtures/go-basic/README.md

@@ -0,0 +1,3 @@
+# Go Basic Fixture
+
+A minimal Go module shape used to smoke-test harness adoption.