relivator — Cursor Rules

• minimize comments: code should be self-explanatory; comment only when needed. • clarity through naming: use clear, descriptive names for variables, functions, classes, components. • comment the "why," not the "what": explain why an approach was taken, especially for non-obvious logic or trade-offs. don't restate what the code does. • avoid obvious comments: don't comment on simple or standard code; assume the reader knows language basics. • consistency: keep comment and doc style consistent across the codebase.

• complex logic: for algorithms or flows not clear from code. • non-obvious decisions (the "why"): explain reasoning behind design choices, workarounds, or optimizations, especially if nonstandard or counterintuitive. • business rules/context: briefly note domain-specific rules or context driving code. • security/performance notes: note important security or performance implications if not obvious. • todos/fixmes: use // todo: or // fixme: for future work, with brief context. use // @ts-expect-error todo: ... only if you tried and failed to fix a typescript error, and disabling it is safe. • jsdoc (public apis): • use doc comments for public functions or modules to describe purpose and usage. • explain conceptual behavior, non-obvious details, or the "why" if needed. • skip redundant tags like @param/@return if typescript types are clear. • use tags only when types aren't enough (e.g., constraints, units, expected format). • add @example for complex apis.

• restating code: e.g., // increment i above i++. • explaining syntax: e.g., // loop through array above for (const item of items) { ... }. • obvious names: e.g., // user's name above const username = .... • commented-out code: delete dead code; git tracks history. • end-of-line noise: avoid trivial comments on code lines. • outdated comments: remove or update comments that no longer match the code.

• full informal freedom: use informal, conversational, or humorous language in comments and docs—just like a real, quirky senior dev. puns, memes, pop culture, playful banter are all fair game, as long as it's not offensive or unprofessional. if a joke helps make a point or keeps things lively, go for it! • be yourself: comments can have personality. if you want to drop a "don't touch this unless you like pain", that's totally fine. • clarity first: even with informality, make sure the comment's intent is clear and helpful to both beginners and seniors.