Skip to content

docs: keep code comments minimal #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bccorb merged 1 commit into from
Jun 27, 2026
Merged

docs: keep code comments minimal #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Direct provider wiring currently lives in [src/config/directMessaging.ts](/Users
- If a route also needs admin checks or rate limiting, combine `auth` with extra `middleware`.
- Be careful around token response shapes and bearer auth. Browser-cookie auth mode has been removed.
- Preserve existing local worktree changes unless the user explicitly asks you to clean them up.
- Keep comments minimal. Comment only when the code genuinely needs explaining (a non-obvious reason or gotcha); do not narrate what the code plainly does.

## Before You Finish A Change

Expand Down
2 changes: 2 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ when specifically exercising real DB behavior.
(`npm run changeset`); don't hand-edit `CHANGELOG.md` or the version in `package.json`.
- **No `any`** (`@typescript-eslint/no-explicit-any` is an error) and imports/exports are
auto-sorted (`simple-import-sort`).
- **Comments** — keep them minimal. Comment only when the code genuinely needs explaining
(a non-obvious reason, a gotcha, an invariant). Don't narrate what the code plainly does.

### Codebase shape (where to make changes)

Expand Down
Loading