agentleFS
kuhlman-labskuhlman-labs/fishhawk/.agents/skills/new-go-module/SKILL.md

new-go-module

Skill9 starsChanged 5 days agoApache-2.0View on GitHub

Add a top-level Go module to the Fishhawk workspace and build/CI wiring. Not needed for a package inside an existing module.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Register it in the workspace: Add ./<name> to the use ( … ) block in /go.work, keeping alphabetical order.

    line 16
  2. Very specific:

    Dependabot: Add a package-ecosystem: gomod entry with directory: /<name> to .github/dependabot.yml, matching the existing entries.

    line 20
  3. Very specific:

    add a <name>/README.md holding the module's contract

    line 22
  4. Very specific:

    add a pointer row in docs/ARCHITECTURE.md §10 "Where to look": path + ≤1 sentence + one anchor issue/ADR ref, line ≤1000 chars

    line 23

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Add a Go module

There is no root go.mod: each top-level component is its own module listed in go.work. A new package inside backend/, runner/ etc. needs none of this. Confirm the user really wants a separate module, which is warranted only when it must be versioned/tagged or depended on independently (ADR-014).

Steps

  1. Create the module
    mkdir <name> && cd <name> && go mod init github.com/kuhlman-labs/fishhawk/<name>
  2. Register it in the workspace. Add ./<name> to the use ( … ) block in /go.work, keeping alphabetical order. go.work is committed; go.work.sum is not.
  3. Wire it into backend/Dockerfile. This is the step most often missed. The image runs go mod download across the whole workspace, so every go.work module's go.mod must be copied first. Without it, the image build fails with cannot load module ../<name>.
    • First COPY phase: COPY <name>/go.mod <name>/go.sum ./<name>/ (omit go.sum if the module has none yet)
    • Source phase: COPY <name> ./<name>
  4. Dependabot. Add a package-ecosystem: gomod entry with directory: /<name> to .github/dependabot.yml, matching the existing entries. .github/** is human-authored and forbidden to Fishhawk implement stages, so if this runs inside a Fishhawk run, hand this step to the operator.
  5. Docs
    • add a <name>/README.md holding the module's contract
    • add a pointer row in docs/ARCHITECTURE.md §10 "Where to look": path + ≤1 sentence + one anchor issue/ADR ref, line ≤1000 chars
  6. Verify
    (cd <name> && go build ./... && go test ./... && golangci-lint run ./...)
    docker build -f backend/Dockerfile . >/dev/null && echo image-ok
    Then run the verify-gate skill.

Already automatic

  • scripts/test, scripts/test lint, scripts/test coverage and scripts/dev all enumerate modules from go.work.
  • CI's scripts/ci-test-leg puts any new non-backend/non-runner module in the rest leg.
  • The 80% aggregate coverage gate includes the new module from day one, so ship it with tests.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.