chore(code-comments): clean comment-discipline violations #17

New issue

Closed

opened 2026-06-08 21:50:48 +00:00 by coilysiren · 0 comments

coilysiren commented

2026-06-08 21:50:48 +00:00

Owner

What

The code-comments pre-commit check (ships from agentic-os) targets two patterns Kai wants gone across her repos:

oversized contiguous comment blocks explaining code that is simple on its own
comments documenting the previous state of the world where the prior state does not matter

This repo carries 55 latent violations under the current check (v0.16.0): 20 in code, 35 in YAML.

Why these are latent

This repo pins agentic-os v0.6.0 but the managed block never listed - id: code-comments, so the check has never run here.

Scope

Bump the managed agentic-os rev to v0.16.0 and add - id: code-comments to the block.
Clean the violations the check surfaces.

Top offenders:

.forgejo/workflows/release.yml - 26
cmd/o2r/client.go - 9
cmd/o2r/channel.go - 5
cmd/o2r/config.go - 5
.ward/ward.yaml - 3
.coily/coily.yaml - 2

Done when

the repo pins agentic-os v0.16.0 with - id: code-comments active in the managed block
pre-commit run code-comments --all-files passes with no excludes grandfathering, beyond genuinely generated or vendored paths

Cross-repo context: the catalogue was built 2026-06-08. Sibling meta-work is tracked in agentic-os (check changes) and infrastructure (ansible version-sync role).

## What The `code-comments` pre-commit check (ships from agentic-os) targets two patterns Kai wants gone across her repos: * oversized contiguous comment blocks explaining code that is simple on its own * comments documenting the previous state of the world where the prior state does not matter This repo carries **55** latent violations under the current check (v0.16.0): 20 in code, 35 in YAML. ## Why these are latent This repo pins agentic-os v0.6.0 but the managed block never listed `- id: code-comments`, so the check has never run here. ## Scope * Bump the managed agentic-os rev to v0.16.0 and add `- id: code-comments` to the block. * Clean the violations the check surfaces. Top offenders: * `.forgejo/workflows/release.yml` - 26 * `cmd/o2r/client.go` - 9 * `cmd/o2r/channel.go` - 5 * `cmd/o2r/config.go` - 5 * `.ward/ward.yaml` - 3 * `.coily/coily.yaml` - 2 ## Done when * the repo pins agentic-os v0.16.0 with `- id: code-comments` active in the managed block * `pre-commit run code-comments --all-files` passes with no `excludes` grandfathering, beyond genuinely generated or vendored paths Cross-repo context: the catalogue was built 2026-06-08. Sibling meta-work is tracked in agentic-os (check changes) and infrastructure (ansible version-sync role).

coilysiren referenced this issue from a commit

2026-06-14 04:53:37 +00:00

chore(code-comments): clean comment-discipline violations

coilysiren closed this issue

2026-06-14 05:07:15 +00:00

Commenting is not possible because the repository is archived.