KofTwentyTwo/Jarvis
2
0 Fork 0
Code Issues 111 Pull Requests 16 Actions Packages Projects Releases 4 Wiki Activity

P3: Apply commenting style guide to leaf packages (opportunistic) #73

New Issue
Open
opened 2026-05-12 19:21:47 +00:00 by KofTwentyTwo · 0 comments
KofTwentyTwo commented 2026-05-12 19:21:47 +00:00 (Migrated from github.com)
Copy link
Copy source

Goal

Bring leaf packages up to the standard in .planning/code-commenting-guide.md opportunistically, per-PR, not as a single bulk rewrite.

Packages in scope

  • packages/Config
  • packages/Keychain
  • packages/Replay
  • packages/Logging
  • packages/Shell
  • packages/DevOverlay
  • packages/Harness

Approach

Every PR that touches a file in one of these packages leaves the comments in the touched lines (and the file's header / type-level docstring, if absent) at or above the standard in the style guide. No bulk rewrite required; this issue stays open as a long-running convention reminder.

Definition of done

This issue closes when:

  • All listed packages have file-level openers + type-level docstrings on every public type.
  • Grep gate (scripts/check-no-stale-plan-id-comments.sh, see sibling tooling issue) reports zero hits across these packages.

Parent epic

#64

Source

.planning/code-commenting-guide.md → Migration plan → P3

## Goal Bring leaf packages up to the standard in `.planning/code-commenting-guide.md` **opportunistically, per-PR**, not as a single bulk rewrite. ## Packages in scope - `packages/Config` - `packages/Keychain` - `packages/Replay` - `packages/Logging` - `packages/Shell` - `packages/DevOverlay` - `packages/Harness` ## Approach Every PR that touches a file in one of these packages leaves the comments in the touched lines (and the file's header / type-level docstring, if absent) at or above the standard in the style guide. No bulk rewrite required; this issue stays open as a long-running convention reminder. ## Definition of done This issue closes when: - All listed packages have file-level openers + type-level docstrings on every public type. - Grep gate (`scripts/check-no-stale-plan-id-comments.sh`, see sibling tooling issue) reports zero hits across these packages. ## Parent epic #64 ## Source .planning/code-commenting-guide.md → Migration plan → P3
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
area:agent
area:build
area:bus
area:devtool
area:hud
area:logging
area:mcp
area:memory
area:vision
area:voice
audit-finding
bug
Something isn't working
 carry-forward
comment-cleanup
Comment / docstring cleanup per .planning/code-commenting-guide.md
 dependencies
Dependency updates
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 epic
good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 javascript
Pull requests that update javascript code
 migration
question
Further information is requested
 severity:critical
severity:high
severity:low
severity:medium
wontfix
This will not be worked on
No labels comment-cleanup enhancement severity:low
Milestone
No items
No Milestone v1.1 — Backlog (Orpheus, WhisperKit, Voice Log, presence, advanced)
Projects
Clear projects
No projects
Assignees
Clear assignees
forge-recovery (Forge Recovery) james.maes (James Maes)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: KofTwentyTwo/Jarvis#73