go-naming
Use when naming any Go identifier — packages, types, functions, methods, variables, constants, or receivers — to ensure idiomatic, clear names. Also use when a user is creating new types, packages, or exported APIs, even if they don't explicitly ask about naming conventions. Does not cover package organization (see go-packages).
- License 许可
- Apache-2.0
- 最近更新
- 2026-10-06
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- go-naming
- description
- Use when naming any Go identifier — packages, types, functions, methods, variables, constants, or receivers — to ensure idiomatic, clear names. Also use when a user is creating new types, packages, or exported APIs, even if they don't explicitly ask about naming conventions. Does not cover package organization (see go-packages).
- allowed-tools
- Bash(bash:*)
02 资源文件 4
- 参考文档references/IDENTIFIERS.md4.5 KB
- 参考文档references/REPETITION.md2.0 KB
- 参考文档references/VARIABLES.md2.8 KB
- 脚本scripts/check-naming.sh7.8 KB
03 SKILL.md 正文
Go Naming Conventions
Resource Routing
scripts/check-naming.sh- Run when checking SCREAMING_SNAKE_CASE constants, Get-prefixed getters, generic package names, or receivers namedthis/self.references/IDENTIFIERS.md- Read when choosing names for initialisms, exported identifiers, or package-level symbols.references/REPETITION.md- Read when names repeat package, receiver, type, or local context.references/VARIABLES.md- Read when choosing local variable names, receiver names, or loop identifiers.
Core Principle
Names should:
- Not feel repetitive when used
- Take context into consideration
- Not repeat concepts that are already clear
Naming is more art than science—Go names tend to be shorter than in other languages.
Naming Decision Flow
What are you naming?
├─ Package → Short, lowercase, singular noun (no underscores, no mixedCaps)
├─ Interface → Method name + "-er" suffix when single-method (Reader, Writer)
├─ Receiver → 1-2 letter abbreviation of type (c for Client); consistent across methods
├─ Constant → MixedCaps; use iota for enums; no ALL_CAPS
├─ Exported func → Verb or verb-phrase in MixedCaps; no Get prefix for getters
├─ Variable → Length proportional to scope distance
│ ├─ Tiny scope (1-7 lines) → single letter (i, n, r)
│ ├─ Medium scope → short word (count, buf)
│ └─ Package-level / wide → descriptive (userAccountCount)
└─ Any name → Check: does it repeat package name or context? If yes, shorten it
MixedCaps (Required)
Normative: All Go identifiers must use MixedCaps.
Underscores are allowed only in: test functions (TestFoo_InvalidInput),
generated code, and OS/cgo interop.
Package Names
Normative: Packages must be lowercase with no underscores.
Short, lowercase, singular nouns. Avoid generic names like util, common,
helper — prefer specific names: stringutil, httpauth, configloader.
// Good: user, oauth2, tabwriter
// Bad: user_service, UserService, count (shadows var)
Interface Names
Advisory: One-method interfaces use "-er" suffix.
Name one-method interfaces by the method plus -er: Reader, Writer,
Formatter. Honor canonical method names (Read, Write, Close, String)
and their signatures.
Receiver Names
Normative: Receivers must be short abbreviations, used consistently.
One or two letters abbreviating the type, consistent across all methods:
func (c *Client) Connect(), func (c *Client) Send().
Never use this or self.
Constant Names
Normative: Constants use MixedCaps, never ALL_CAPS or K prefix.
Name constants by role, not value: MaxRetries not Three,
DefaultPort not Port8080.
const MaxPacketSize = 512
const defaultTimeout = 30 * time.Second
Initialisms and Acronyms
Normative: Initialisms maintain consistent case throughout.
Initialisms (URL, ID, HTTP, API) must be all uppercase or all lowercase:
HTTPClient, userID, ParseURL() — not HttpClient, orderId, ParseUrl().
Function and Method Names
Advisory: No
Getprefix for simple accessors; use verb-like names for actions.
Getter for field owner is Owner(), not GetOwner(). Setter is
SetOwner(). Use Compute or Fetch for expensive operations.
When functions differ only by type, include type at the end:
ParseInt(), ParseInt64().
Variable Names
Variable naming balances brevity with clarity. Key principles:
- Scope-based length: Short names (
i,v) for small scopes; longer, descriptive names for larger scopes - Single-letter conventions: Use familiar patterns (
ifor index,r/wfor reader/writer) - Avoid type in name: Use
usersnotuserSlice,namenotnameString - Prefix unexported globals: Use
_prefix for package-level unexported vars/consts to prevent shadowing
for i, v := range items { ... } // small scope
pendingOrders := filterPending(orders) // larger scope
const _defaultPort = 8080 // unexported global
Avoiding Repetition
Go names should not feel repetitive when used. Consider the full context:
- Package + symbol:
widget.New()notwidget.NewWidget() - Receiver + method:
p.Name()notp.ProjectName() - Context + type: In package
sqldb, useConnectionnotDBConnection
Avoid Built-In Names
Never shadow Go's predeclared identifiers (error, string, len, cap,
append, copy, new, make, etc.) as variable, parameter, or type names.
For detailed guidance: See go-declarations — "Avoid Using Built-In Names"
section.
Quick Reference
| Element | Rule | Example |
|---|---|---|
| Package | lowercase, no underscores | package httputil |
| Exported | MixedCaps, starts uppercase | func ParseURL() |
| Unexported | mixedCaps, starts lowercase | func parseURL() |
| Receiver | 1-2 letter abbreviation | func (c *Client) |
| Constant | MixedCaps, never ALL_CAPS | const MaxSize = 100 |
| Initialism | consistent case | userID, XMLAPI |
| Variable | length ~ scope size | i (small), userCount (large) |
| Built-in names | Never shadow predeclared identifiers | See go-declarations |
Validation: After renaming identifiers, run
bash scripts/check-naming.shto verify no naming anti-patterns remain. Then rungo build ./...to confirm the rename didn't break anything.
Related Skills
- Interface naming: See go-interfaces when naming interfaces with the
-ersuffix or choosing receiver types - Package naming: See go-packages when naming packages, avoiding
util/common, or resolving import collisions - Error naming: See go-error-handling when naming sentinel errors (
ErrFoo) or custom error types - Declaration scope: See go-declarations when variable name length depends on scope or when avoiding built-in shadowing
- Style principles: See go-style-core when balancing clarity vs concision in identifier names
04 同仓库更多 Skills
tb-writing-plans
Use when you have a spec or requirements for a multi-step task, before touching code
tb-using-git-worktrees
Use when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback
tb-test-driven-development
Use when implementing any feature or bugfix, before writing implementation code
tb-subagent-driven-development
Use when executing implementation plans with independent tasks in the current session
tb-scrutinize
Outsider-perspective end-to-end review of a plan, PR, or code change. First questions intent and whether a simpler/more elegant approach would achieve the same goal, then traces the actual code path (not just the diff) to verify the change does what it claims. Output is concise, actionable, and every call carries its rationale. Trigger on /tb-scrutinize and proactively whenever the user asks to review, audit, sanity-check, or get a second opinion on a plan, PR, diff, design doc, or proposed code change.
tb-requesting-code-review
Use when completing tasks, implementing major features, or before merging to verify work meets requirements