From bed90fee2dcaf3dccc222d524681a73a07672d9b Mon Sep 17 00:00:00 2001 From: Julian lechner Date: Thu, 1 Oct 2026 10:22:50 +0200 Subject: [PATCH] docs(rules): align technology comment rules Co-Authored-By: Claude Opus 5.5 --- shared/rules/angular/references/testing-and-architecture.md | 2 +- shared/rules/typescript/references/coding-style.md | 2 +- shared/rules/wpf/references/architecture-and-quality.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/shared/rules/angular/references/testing-and-architecture.md b/shared/rules/angular/references/testing-and-architecture.md index 20c0322..70a7be2 100644 --- a/shared/rules/angular/references/testing-and-architecture.md +++ b/shared/rules/angular/references/testing-and-architecture.md @@ -38,7 +38,7 @@ * Remove dead code. * Remove unused imports and dependencies. * Remove commented-out code instead of keeping it in source files. -* Do not add comments unless the user explicitly requests them. +* Add comments only for non-obvious decisions or public contracts. * Treat Angular, TypeScript and lint warnings seriously. * Do not suppress diagnostics without a concrete reason. * Prefer correctness, security and maintainability over cleverness. diff --git a/shared/rules/typescript/references/coding-style.md b/shared/rules/typescript/references/coding-style.md index 2c58d57..15ef237 100644 --- a/shared/rules/typescript/references/coding-style.md +++ b/shared/rules/typescript/references/coding-style.md @@ -9,4 +9,4 @@ Apply these rules when changing TypeScript syntax, control flow, or everyday cod * Use strict equality. Handle `null` and `undefined` intentionally and do not use `||` when `0`, `false`, or an empty string is a valid value. * Use optional chaining and nullish coalescing where they clarify behavior; avoid mixing nullish conventions without a project reason. * Keep naming descriptive and consistent. Avoid vague names and abbreviations unless they are established domain terms. -* Remove dead code and unused imports. Do not add comments unless the user asks or a project rule requires them. +* Remove dead code and unused imports. Add comments only for non-obvious decisions or public contracts. diff --git a/shared/rules/wpf/references/architecture-and-quality.md b/shared/rules/wpf/references/architecture-and-quality.md index b2113b6..d0faef4 100644 --- a/shared/rules/wpf/references/architecture-and-quality.md +++ b/shared/rules/wpf/references/architecture-and-quality.md @@ -44,7 +44,7 @@ * Use descriptive names. * Remove dead code. * Remove commented-out code. -* Do not add comments unless the user explicitly requests them. +* Add comments only for non-obvious decisions or public contracts. * Treat compiler, analyzer and binding warnings seriously. * Do not suppress warnings without a concrete reason. * Prefer correctness, responsiveness, security and maintainability over cleverness.