Skip to content

chore: Enforce Minimal Code Comments - #2630

Merged
camielvs merged 1 commit into
masterfrom
08-13-chore_enforce_minimal_code_comments
Aug 19, 2026
Merged

chore: Enforce Minimal Code Comments#2630
camielvs merged 1 commit into
masterfrom
08-13-chore_enforce_minimal_code_comments

Conversation

@camielvs

@camielvs camielvs commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Description

Claude has been bloating our codebase with spammy code comments for far too long. This PR aims to reign in the AI and assert dominance!

Hopefully after this we will get much less long-winded and pointless code comments. Updated directives to the AI aim to remove the JSDoc standard and reduce self-explanatory code comments. The PR also does an initial high-level sweep and cleans up a few places as a proof of concept.

This should make our code more concise and readable in the long term.

Related Issue and Pull requests

Type of Change

  • Improvement
  • Cleanup/Refactor
  • Documentation update

Checklist

  • I have tested this does not break current pipelines / runs functionality
  • I have tested the changes on staging

Screenshots (if applicable)

Test Instructions

Additional Comments

@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown

🎩 Preview

A preview build has been created at: 08-13-chore_enforce_minimal_code_comments/8f4b718

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@camielvs
camielvs marked this pull request as ready for review August 14, 2026 01:03
@camielvs
camielvs requested a review from a team as a code owner August 14, 2026 01:03

@morgan-wowk morgan-wowk left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Agent review. Verified no functional directive comments were removed anywhere (no eslint-disable/@ts-*/pragmas/etc.), the one doc value change (MIN_DOCKED_HEIGHT 100→50 in WINDOWS.md) is a correct fix vs the actual constant, and the branch passes pnpm run lint. One cross-PR concern (inline).

Comment thread eslint.config.js Outdated
@camielvs
camielvs force-pushed the 08-13-chore_enforce_minimal_code_comments branch from 7e0d865 to 96425ae Compare August 18, 2026 18:56

Copy link
Copy Markdown
Collaborator Author

^ inline concern has been addressed

@camielvs
camielvs force-pushed the 08-13-chore_enforce_minimal_code_comments branch from 96425ae to 360fae0 Compare August 18, 2026 19:34
@camielvs
camielvs requested a review from morgan-wowk August 18, 2026 19:35

@morgan-wowk morgan-wowk left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Agent-assisted re-review (posted by Morgan). Approving. local/no-type-member-comments is now warn rather than error, which resolves the concern: in-flight branches that still carry an interface/object-type comment will surface a lint warning on rebase instead of a hard CI failure, so nobody gets a silent red build from a merge they didn't touch. Flipping to error later once the tree is clean is an easy follow-up. (The minor 'rename the field' message not quite fitting inline TSTypeLiteral cases is cosmetic — fine to leave.)

camielvs commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator Author

Merge activity

  • Aug 19, 12:08 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Aug 19, 12:09 AM UTC: Graphite rebased this pull request as part of a merge.
  • Aug 19, 12:13 AM UTC: @camielvs merged this pull request with Graphite.

@camielvs
camielvs force-pushed the 08-13-chore_enforce_minimal_code_comments branch from 360fae0 to 8f4b718 Compare August 19, 2026 00:09
@camielvs
camielvs merged commit 6960c56 into master Aug 19, 2026
17 checks passed
@camielvs
camielvs deleted the 08-13-chore_enforce_minimal_code_comments branch August 19, 2026 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants