Compare commits
1 Commits
golangci-l
...
a614cd6ffb
| Author | SHA1 | Date | |
|---|---|---|---|
| a614cd6ffb |
@@ -124,15 +124,10 @@ last_modified: 2026-03-18
|
||||
|
||||
1. Keep the `main()` function as small as possible.
|
||||
|
||||
1. Keep the `main` package as small as possible. Each `cmd/<name>/` directory
|
||||
contains a single `main.go` whose body is one call into library code (for
|
||||
example `os.Exit(cli.Main())` calling `internal/cli`). All CLI logic — flag
|
||||
parsing, subcommand dispatch, argument handling, output formatting — lives
|
||||
in `internal/` or `pkg/`, not in `cmd/`. `main` is just an entrypoint to
|
||||
your code, not a place for implementations. Exception: single-file scripts.
|
||||
|
||||
1. No project logic outside `internal/` or `pkg/`. Anything in `cmd/` is a thin
|
||||
entrypoint only.
|
||||
1. Keep the `main` package as small as possible. Move as much code as is
|
||||
feasible to a library package, even if it's an internal one. `main` is just
|
||||
an entrypoint to your code, not a place for implementations. Exception:
|
||||
single-file scripts.
|
||||
|
||||
1. HTTP HandleFuncs should be returned from methods or functions that need to
|
||||
handle HTTP requests. Don't use methods or your top level functions as
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Repository Policies
|
||||
last_modified: 2026-09-05
|
||||
last_modified: 2026-08-19
|
||||
---
|
||||
|
||||
This document covers repository structure, tooling, and workflow standards. Code
|
||||
@@ -270,10 +270,8 @@ style conventions are in separate documents:
|
||||
configuration changes are made to the canonical copy in the `prompts` repo and
|
||||
reach consuming repos by re-vendoring; an agent may open a PR against
|
||||
canonical, which only the user merges. The canonical golangci-lint version is
|
||||
v2.13.2 (released 2026-08-27, built with Go 1.27; a linter built with an older
|
||||
Go cannot check a module whose `go` directive is newer), installed
|
||||
commit-pinned via
|
||||
`go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@27774aaf853a4fd21f1dd5e69439459dc1b26e68`.
|
||||
v2.12.2 (released 2026-05-06), installed commit-pinned via
|
||||
`go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@c0d3ddc9cf3faa61a4e378e879ece580256d76e5`.
|
||||
|
||||
- When pinning images or packages by hash, add a comment above the reference
|
||||
with the version and date (YYYY-MM-DD).
|
||||
@@ -392,9 +390,7 @@ style conventions are in separate documents:
|
||||
language-specific config). Everything else goes in a subdirectory. Canonical
|
||||
subdirectory names:
|
||||
- `bin/` — executable scripts and tools
|
||||
- `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
|
||||
body is a single call into `internal/` or `pkg/`, no project logic in
|
||||
`cmd/`
|
||||
- `cmd/` — Go command entrypoints
|
||||
- `configs/` — configuration templates and examples
|
||||
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
||||
- `docs/` — documentation and markdown (README.md stays in root)
|
||||
|
||||
Reference in New Issue
Block a user