From 466b5a8e0829ef19f321607fd0d1c900b9fd15b2 Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Wed, 13 May 2026 21:48:22 +0200 Subject: [PATCH] docs: Move logging guidance to CONTRIBUTING Keep logging and comment-style guidance in CONTRIBUTING.md and trim duplicate policy from the agent guide. On-behalf-of: SAP philipp.schuster@sap.com Signed-off-by: Philipp Schuster --- AGENTS.md | 5 ----- CONTRIBUTING.md | 4 ++++ 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index b70d85855..28cbbccfa 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -36,11 +36,6 @@ reviewable, and compatible with the project's normal engineering constraints. comment with the invariants, and make sure the surrounding code upholds them. - Assume concurrency matters. Avoid races, unsynchronized shared state, and implicit ordering assumptions; prefer clear ownership and synchronization. -- Keep docs and comments short and useful. Document non-trivial invariants at - struct definitions and critical state transitions. -- Logging should be minimal and high signal. Use `info!` for important normal - state changes that matter in production; use `warn!` or `error!` only for - abnormal conditions. Keep `debug!` for focused diagnostics. ### Build and Test Notes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6748656ea..25407b4c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,10 @@ For new code, add documentation and comments where they **provide additional val Comments should be concise and add additional context or information to the code. +Logging should be minimal and high signal. Use `info!` for important normal +state changes that matter in production; use `warn!` or `error!` only for +abnormal conditions. Keep `debug!` for focused diagnostics. + [Rust Style]: https://github.com/rust-lang/rust/tree/HEAD/src/doc/style-guide/src ## Basic Checks