Skip to content

Design 0005: Go as an org language - #65

Merged
gavinbee merged 4 commits into
mainfrom
0005-go-standard
Nov 12, 2026
Merged

gavinbee merged 4 commits into
mainfrom
0005-go-standard

Conversation

@gavinbee

Copy link
Copy Markdown
Contributor

Refs #63 (the issue tracks the rollout this record describes, so it stays open after this merges)

What & why

Adds design 0005: Go becomes a first-class org language next to Python. swimblocks/fetch-service is the first Go repo, a long-running service that more than one crawler calls.

  • When to use it: Go for services and long-running backends, Python where its libraries are the reason. Neither is a rule.
  • Toolchain:
    • always the current stable Go release, set in go.mod
    • module path github.com/swimblocks/<repo>
    • golangci-lint v2 with the standard linters plus gofmt/goimports
    • a reusable Go CI workflow
    • distroless static images
    • Dependabot gomod
  • Layout and naming: binaries in cmd/<kebab-case>/ and everything else in internal/. Package directories are single lowercase words, since Go requires a package name to be a valid identifier. Source files stay snake_case and tests sit beside the code.

Testing

Design record only. Reviewed in crit: 5 comments, all addressed.

Checklist

  • Linked the issue
  • Tests added/updated and passing (n/a, docs only)
  • ruff check . clean (n/a, docs only)
  • Docs updated (design index)

🤖 Generated with Claude Code

Refs #63

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The design document misrepresents go.sum as a lockfile and reports a passing actionlint check for a workflow that has not yet been delivered.

2 open issues
What changed in this PR

This docs-only PR proposes Go as a first-class SwimBlocks language alongside Python, with fetch-service as the first adopter. Implementation is tracked in #63.

Changes:

  • Defines language-selection guidance and Go tooling, layout, naming, and testing conventions.
  • Outlines reusable CI, containers, dependency updates, and rollout plans.
  • Adds design 0005 to the index with proposed status.
File Description
docs/​design/​README.md Lists design 0005 as proposed.
docs/​design/​0005-go-standard.md Documents the proposed Go standard and adoption plan.

Review effort: Balanced

Comment thread docs/design/0005-go-standard.md Resolved
Comment thread docs/design/0005-go-standard.md Resolved
gavinbee and others added 2 commits November 12, 2026 14:09
Clarified vendoring policy and explained go.sum usage.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Refs #63

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@gavinbee

Copy link
Copy Markdown
Contributor Author

@copilot resolve the merge conflicts in this pull request

Co-authored-by: gavinbee <29419542+gavinbee@users.noreply.github.com>

Copilot AI commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

Resolved the conflict in docs/design/README.md, retaining both design 0005 and 0006 entries. The merge commit is 8b79901.

@gavinbee
gavinbee merged commit 40f6543 into main Nov 12, 2026
1 check passed
@gavinbee
gavinbee deleted the 0005-go-standard branch November 12, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants