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

New issue

Closed

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

coilysiren commented

2026-06-08 21:50:49 +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 245 latent violations under the current check (v0.16.0): 84 in code, 161 in YAML.

Why these are latent

This repo does not pin agentic-os and never adopted the managed hook block, so code-comments has never run here. Both code and YAML violations are latent.

Scope

Adopt the managed agentic-os hook block at v0.16.0 with code-comments active (run agentic-os/scripts/apply-agentic-os-hooks.py).
Clean the violations the check surfaces.

Top offenders:

tempo_grafana/docker/grafana/provisioning/datasources/datasources.yaml - 34
core/chart/values.yaml - 32
tempo_grafana/docker/tempo.yaml - 30
scripts/check_luca_spans.py - 20
tempo_grafana/docker/docker-compose.yml - 17
arize_phoenix/src/otel_a2a_relay_arize_phoenix/viz/render.py - 11

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 **245** latent violations under the current check (v0.16.0): 84 in code, 161 in YAML. ## Why these are latent This repo does not pin agentic-os and never adopted the managed hook block, so `code-comments` has never run here. Both code and YAML violations are latent. ## Scope * Adopt the managed agentic-os hook block at v0.16.0 with `code-comments` active (run `agentic-os/scripts/apply-agentic-os-hooks.py`). * Clean the violations the check surfaces. Top offenders: * `tempo_grafana/docker/grafana/provisioning/datasources/datasources.yaml` - 34 * `core/chart/values.yaml` - 32 * `tempo_grafana/docker/tempo.yaml` - 30 * `scripts/check_luca_spans.py` - 20 * `tempo_grafana/docker/docker-compose.yml` - 17 * `arize_phoenix/src/otel_a2a_relay_arize_phoenix/viz/render.py` - 11 ## 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

2026-06-09 00:52:33 +00:00

chore(mypy): clear the strict-mode typing backlog (63 errors) #65

coilysiren referenced this issue from a commit

2026-06-09 02:03:07 +00:00

chore(code-comments): clean comment-discipline violations + adopt v0.16.0 hook block

coilysiren closed this issue

2026-06-09 02:03:07 +00:00

Commenting is not possible because the repository is archived.