coilyco-flight-deck/galaxy-gen
1
0
Fork 0
Code Issues 11 Pull requests Projects Releases Packages Wiki Activity Actions

chore: clean up code-comments violations (agentic-os v0.2.8) #8

New issue
Open
opened 2026-05-26 05:22:56 +00:00 by coilysiren · 0 comments
coilysiren commented 2026-05-26 05:22:56 +00:00
Owner
Copy link

Problem

The agentic-os pre-commit suite v0.2.8 enables code-comments with MAX_CONTIGUOUS=2 and a 90-char line cap. This repo currently has approximately 246 violations - mostly first-party multi-line docstrings, package godoc, and inline explanations.

Fix

Walk every flagged file. For each block:

  • Single sentence fitting 2 lines: leave as-is (allowed).
  • 3+ line block: move durable detail to docs/<topic>.md, leave a one-line pointer (// see docs/<topic>.md) at the comment site.
  • Go package godoc: keep first 2 lines as summary, move rest to docs/.

Verify with:

pre-commit run code-comments --all-files

The dirty .claude/lockdown-deny.sh / .claude/settings.json and the rev: v0.2.8 bump in .pre-commit-config.yaml belong in the same commit per AGENTS.md sweep rule.

Rule shape

Rule softened from TOL=1 to TOL=2 in coilysiren/agentic-os#24. Vendored-file escape hatch tracked separately at coilysiren/agentic-os#22.

Ported from coilysiren/galaxy-gen#76.

**Problem** The agentic-os pre-commit suite v0.2.8 enables `code-comments` with MAX_CONTIGUOUS=2 and a 90-char line cap. This repo currently has approximately **246** violations - mostly first-party multi-line docstrings, package godoc, and inline explanations. **Fix** Walk every flagged file. For each block: - Single sentence fitting 2 lines: leave as-is (allowed). - 3+ line block: move durable detail to `docs/<topic>.md`, leave a one-line pointer (`// see docs/<topic>.md`) at the comment site. - Go package godoc: keep first 2 lines as summary, move rest to `docs/`. Verify with: ``` pre-commit run code-comments --all-files ``` The dirty `.claude/lockdown-deny.sh` / `.claude/settings.json` and the `rev: v0.2.8` bump in `.pre-commit-config.yaml` belong in the same commit per AGENTS.md sweep rule. **Rule shape** Rule softened from TOL=1 to TOL=2 in coilysiren/agentic-os#24. Vendored-file escape hatch tracked separately at coilysiren/agentic-os#22. --- _Ported from coilysiren/galaxy-gen#76._
coilysiren added
P4
 and removed
P3
 labels 2026-05-31 07:00:29 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
dispatch/issue-76
No results found.
Labels
Clear labels
  
P0
now / blocking / urgent

  
P1
next / important

  
P2
backlog / will do

  
P3
someday / low

  
P4
icebox / frozen / reopen if it becomes real

No labels
P0
P1
P2
P3
P4
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
coilyco-flight-deck/galaxy-gen#8
No description provided.