You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by el...@apache.org on 2025/09/18 23:58:16 UTC
(superset) 01/01: docs: Add instruction to avoid time-specific language in code comments
This is an automated email from the ASF dual-hosted git repository.
elizabeth pushed a commit to branch elizabeth/llm-docs
in repository https://gitbox.apache.org/repos/asf/superset.git
commit 9c17612c423a548248bb87800ce6b1391486500d
Author: Elizabeth Thompson <es...@gmail.com>
AuthorDate: Thu Sep 18 16:36:08 2025 -0700
docs: Add instruction to avoid time-specific language in code comments
Added guidance to LLM documentation instructing to avoid words like "now",
"currently", "today" in code comments as they become outdated. Comments
should remain accurate regardless of when they're read.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <no...@anthropic.com>
---
LLMS.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/LLMS.md b/LLMS.md
index 05576b8a05..3b861ad715 100644
--- a/LLMS.md
+++ b/LLMS.md
@@ -70,6 +70,10 @@ superset/
- **New files require ASF license headers** - When creating new code files, include the standard Apache Software Foundation license header
- **LLM instruction files are excluded** - Files like LLMS.md, CLAUDE.md, etc. are in `.rat-excludes` to avoid header token overhead
+### Code Comments
+- **Avoid time-specific language** - Don't use words like "now", "currently", "today" in code comments as they become outdated
+- **Write timeless comments** - Comments should remain accurate regardless of when they're read
+
## Documentation Requirements
- **docs/**: Update for any user-facing changes