Skip to content

Commit a5ad1d1

Browse files
eschuthoclaude
andauthored
docs: Add instruction to avoid time-specific language in code comments (#35200)
Co-authored-by: Claude <[email protected]>
1 parent db88d80 commit a5ad1d1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

LLMS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ superset/
7070
- **New files require ASF license headers** - When creating new code files, include the standard Apache Software Foundation license header
7171
- **LLM instruction files are excluded** - Files like LLMS.md, CLAUDE.md, etc. are in `.rat-excludes` to avoid header token overhead
7272

73+
### Code Comments
74+
- **Avoid time-specific language** - Don't use words like "now", "currently", "today" in code comments as they become outdated
75+
- **Write timeless comments** - Comments should remain accurate regardless of when they're read
76+
7377
## Documentation Requirements
7478

7579
- **docs/**: Update for any user-facing changes

0 commit comments

Comments
 (0)