Propose permanent Go naming rules, starting with package names #174

Open
opened 2026-11-16 06:09:20 +01:00 by clawbot · 0 comments
Collaborator

sneak, on sneak/homoicon#2100 (comment): "Don't name packages model. It doesn't convey any meaning. Every program has a data model. Read some websites about how to name things idiomatically in Go, and propose some permanent rules as a result."

Task

Read the established guidance on naming in Go: the Go blog post "Package names", Effective Go, the Go Code Review Comments wiki, and the Google Go style guide's naming sections. From them, propose permanent naming rules for sneak's Go code, covering at least package names (no model, util, common, types, helpers and the like), and the names of exported types, functions and variables as seen from the calling package.

Write the proposal as a PR against next that adds the rules to prompts/CODE_STYLEGUIDE_GO.md (or the Go style guide file this repo has). Each rule is one short line with a one-clause reason. Where a rule comes from one of the sources, cite it by name in the PR body, not in the guide.

Then stop. sneak approves or amends the rules before anything is renamed in any repo.

Definition of done

  • A PR against next with the proposed rules in the Go style guide, make check passing.
  • The PR assigned to sneak for approval.

Model: opus-5-5

sneak, on https://git.eeqj.de/sneak/homoicon/issues/2100#issuecomment-181459: "Don't name packages `model`. It doesn't convey any meaning. Every program has a data model. Read some websites about how to name things idiomatically in Go, and propose some permanent rules as a result." ## Task Read the established guidance on naming in Go: the Go blog post "Package names", Effective Go, the Go Code Review Comments wiki, and the Google Go style guide's naming sections. From them, propose permanent naming rules for sneak's Go code, covering at least package names (no `model`, `util`, `common`, `types`, `helpers` and the like), and the names of exported types, functions and variables as seen from the calling package. Write the proposal as a PR against `next` that adds the rules to `prompts/CODE_STYLEGUIDE_GO.md` (or the Go style guide file this repo has). Each rule is one short line with a one-clause reason. Where a rule comes from one of the sources, cite it by name in the PR body, not in the guide. Then stop. sneak approves or amends the rules before anything is renamed in any repo. ## Definition of done - A PR against `next` with the proposed rules in the Go style guide, `make check` passing. - The PR assigned to sneak for approval. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/prompts#174