484dc7dd07
fix: update drifted file:line citations in Go patterns
...
Upstream golang/go has shifted several line numbers since citations
were recorded. Updated 6 citations across 3 files:
- documentation.md: server.go:55-57 → 59-62 (ErrWriteAfterFlush)
- documentation.md: transport.go:79-80 → 72-73 (Transports should be reused)
- structs.md: client.go:31-35 → 30-34 (A Client is an HTTP client)
- structs.md: client.go:59-60 → 57-58 (type Client struct)
- style.md: stream.go:280 → 292 (var _ Marshaler)
- style.md: stream.go:280-281 → 292-293 (var _ Marshaler/Unmarshaler)
Verified against golang/go HEAD (depth=1 clone).
2026-05-27 05:52:38 +00:00
52a3629583
fix: correct drifted line citations in time/time.go and net/http/server.go
...
- time/time.go:928-933 -> 925-933 ("To count the number of units" block starts at 925)
- time/time.go:936-943 -> 934-942 (const Duration block starts at 934)
- net/http/server.go:3173-3174 -> 3171-3174 (Close() func starts at 3171)
2026-05-18 15:07:04 +00:00
f070fef8ee
fix(citations): correct NewServeMux citation in package-design.md
...
server.go:2639 → 2638 (function declaration line)
Body drift: 'return new(ServeMux)' → 'return &ServeMux{}'
2026-05-11 08:04:32 -07:00
0de5f54365
fix: correct drifted citation for tls.Config.Clone
...
crypto/tls/common.go#L925 was wrong; the Clone() method is at L996
in commit 17bd5ab8c650155dd2bd09f7005726552639eea0.
Audited all citations across all pattern .md files — only this one
had drifted. All others verified OK against the pinned golang/go commit.
2026-05-06 17:21:18 -07:00
52503d24c2
fix: update drifted file:line citations to match current golang/go source
...
Audited all file:line citations against golang/go HEAD.
97 citations checked; 9 had drifted by 1-20 lines (off-by-one or small
structural shifts in the stdlib source). Updated both inline code block
comments and corresponding GitHub #L anchor links.
Changes per file:
patterns/api-conventions.md - strings/builder.go WriteString (92→112), String (48→46)
patterns/configuration.md - crypto/tls/common.go Time field (572→575)
patterns/documentation.md - net/http/server.go Handler comment (64→65), os/file.go example (17→16)
patterns/structs.md - os/types.go File struct (16→15), strings/builder.go copyCheck (25→32)
patterns/style.md - net/http/server.go TLSConfig (3041→3040), import block (8→9)
2026-05-06 17:17:20 -07:00
c8ed244a07
feat: add source hyperlinks (commit SHA permalinks) to all pattern files
...
Every source reference now links to the exact line in the golang/go
repo at commit 17bd5ab. Added PATTERN_COMPLETE sentinels.
Total: 154 hyperlinks across 10 topic files.
2026-04-30 14:42:20 -07:00
99c0865e93
docs: add configuration.md (skill test output), remove thin from-source.md
...
10 patterns, 989 lines. Full skill spec compliance:
- Source hyperlinks (commit SHA permalinks)
- Before/after code examples for every pattern
- Over-application warnings with code
- Anti-patterns with DON'T/DO blocks
- Decision tree at end
- Cross-references to related topic files
Patterns: zero-value config, options struct, functional options,
default instances, init-time registration, context values,
builder (anti-pattern), function fields, immutable-after-use, Clone.
2026-04-30 14:26:31 -07:00
c7e61565c0
docs: full iterative patterns extraction from golang/go
...
794 lines, 35+ patterns across 9 topics with hyperlinked sources.
Includes frequency data from the source (281 interfaces, 55 sentinels,
262 constructors, 309 context-accepting functions, 2685 t.Helper calls).
Topics: interfaces, errors, testing, packages, concurrency,
documentation, naming, configuration, extension, performance, smells.
All examples are real code from the Go source, not invented.
2026-04-30 13:45:02 -07:00
dfe03e0675
fix: add 'When to use' to every pattern (was missing)
2026-04-30 13:29:50 -07:00
65cae45f13
docs: add patterns extracted from golang/go source
...
Using codebase-analysis skill (patterns mode) on the language source.
Real examples from the repo, not invented. Each pattern has:
- Rule, Example, Why, When NOT to use, Source file.
Topics: interface design, error handling, testing, package org,
concurrency, documentation, naming, smells.
2026-04-30 13:26:29 -07:00
aweiker
733aa7d261
docs: add when-not to style + smells (package-design + documentation already done)
2026-04-30 13:31:47 +00:00
aweiker
11048ae73e
docs: add when-not to interfaces + error-handling + concurrency
2026-04-30 13:26:20 +00:00
aweiker
a7a853bb43
docs: add when-not to structs + testing-advanced + api-conventions
2026-04-30 13:24:01 +00:00
aweiker
eb9171368b
docs: add 'when to use' triggers + examples to all patterns
...
Added 'When to Use' subsections with concrete decision triggers and
before/after Go code examples to patterns across all directories:
- patterns/error-handling.md (3 patterns: sentinels, wrapping, Join)
- patterns/concurrency.md (4 patterns: Mutex, Once, done channels, pipelines)
- patterns/interfaces.md (4 patterns: small interfaces, accept/return, adapter, optional)
- patterns/structs.md (3 patterns: zero-value, constructors, config structs)
- patterns/package-design.md (3 patterns: internal/, init(), context keys)
- patterns/style.md (3 patterns: interface checks, iota constants, named types)
- patterns/testing-advanced.md (3 patterns: table tests, golden files, httptest)
- patterns/api-conventions.md (3 patterns: Must, layered API, graceful shutdown)
- patterns/documentation.md (2 patterns: examples, deprecated)
- kubernetes/patterns.md (3 patterns: controller, workqueue, leader election)
- kubernetes/production-go.md (2 patterns: codegen, HandleCrash)
- smells/anti-patterns.md (2 anti-patterns: cache mutation, edge-triggered)
2026-04-30 12:08:41 +00:00
c797178fb9
docs: idiomatic Go patterns from stdlib + Kubernetes with source citations
2026-04-30 11:07:33 +00:00
0f1d7e4c06
feat: initial Go patterns guide from stdlib + Kubernetes source study
...
9 pattern files covering stdlib (structs, interfaces, API conventions, docs, style),
Kubernetes (controller/reconciler, informer/cache, leader election, code generation),
comparison (stdlib vs K8s approaches), and anti-patterns.
All patterns cite exact source files and line numbers.
2026-04-30 06:34:02 +00:00
Rodin
Rodin
aweiker