From b68fccdb8c3e17e64e71ca22a15d88364a73f947 Mon Sep 17 00:00:00 2001 From: Angie Jones Date: Mon, 10 Nov 2025 13:54:42 -0600 Subject: [PATCH] clarify agent instructions (#5655) --- .github/copilot-instructions.md | 3 ++- AGENTS.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index deb8d64ca4..173fec0dc7 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -43,7 +43,8 @@ - Suggestions to add comments for self-documenting code - Refactoring suggestions unless there's a clear bug or maintainability issue - Listing multiple potential issues in one comment (choose the single most critical issue) -- Suggestions to add more logging (the codebase needs less logging, not more) +- Suggestions to add logging statements, unless for errors or security events (the codebase needs less logging, not more) + ## Response Format diff --git a/AGENTS.md b/AGENTS.md index 35e0cc08c6..75a4c5f0c4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -85,7 +85,7 @@ Simplicity: Don't make things optional that don't need to be - the compiler will Simplicity: Booleans should default to false, not be optional Errors: Don't add error context that doesn't add useful information (e.g., `.context("Failed to X")` when error already says it failed) Simplicity: Avoid overly defensive code - trust Rust's type system -Logging: Clean up existing logs, don't add more +Logging: Clean up existing logs, don't add more unless for errors or security events ## Never