coilysiren/algo-zone
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

New issue
Closed
opened 2026-06-08 21:50:59 +00:00 by coilysiren · 0 comments
coilysiren commented 2026-06-08 21:50:59 +00:00
Owner
Copy link

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 16 latent violations under the current check (v0.16.0): 0 in code, 16 in YAML.

Why these are latent

This repo pins agentic-os v0.11.1, which predates YAML enforcement (landed in v0.14.0 on 2026-06-04). code-comments runs on code today but has never scanned YAML here, so the YAML violations are latent.

Scope

  • Bump the managed agentic-os rev to v0.16.0.
  • Clean the YAML violations the upgraded check surfaces.

Top offenders:

  • config.yml - 11
  • .github/workflows/config.yml - 3
  • .pre-commit-config.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 **16** latent violations under the current check (v0.16.0): 0 in code, 16 in YAML. ## Why these are latent This repo pins agentic-os v0.11.1, which predates YAML enforcement (landed in v0.14.0 on 2026-06-04). `code-comments` runs on code today but has never scanned YAML here, so the YAML violations are latent. ## Scope * Bump the managed agentic-os rev to v0.16.0. * Clean the YAML violations the upgraded check surfaces. Top offenders: * `config.yml` - 11 * `.github/workflows/config.yml` - 3 * `.pre-commit-config.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).
Commenting is not possible because the repository is archived.
No Branch/Tag specified
Branches Tags
main
sql-create-table
sql-origin
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
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
coilysiren/algo-zone#9
No description provided.