Skip to content

Commit c98e9dc

Browse files
authored
docs: fix lint issue (#557)
1 parent 39b7b07 commit c98e9dc

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Implement in sequential passes. Don't write code until you've completed the veri
6464
**Pass 2: Check scope.** Does this need to exist? Check if it already exists in the API. Is this the library's job or the user's job? The library handles protocol correctness; application concerns (reconnection, auth, routing) belong in user code.
6565

6666
**Pass 3: Check invariants.** Walk through Key Invariants before writing code:
67+
6768
- Reads: Will something still read from the connection?
6869
- Pools: Will pooled objects be returned on all paths?
6970
- Locks: Are you using context-aware `mu`, not `sync.Mutex`?
@@ -118,6 +119,7 @@ Never use emdash. Use commas, semicolons, or separate sentences.
118119
**Naming matters.** Before proposing a name, stop and review existing names in the file. Ask: what would someone assume from this name? Does it fit with how similar things are named? A good name is accurate on its own and consistent in context.
119120

120121
**Comment content:**
122+
121123
- Add information beyond what the code shows (not tautologies)
122124
- State directly: "Returns X" (not "Note that this returns X")
123125
- Drop filler: "basically", "actually", "really" add nothing

0 commit comments

Comments
 (0)