@yaawn/workflow 0.0.0-stage → 0.3.1

package/agents/instructions/yaawn-open-source-first.instructions.md

@@ -0,0 +1,38 @@
+---
+applyTo: "**/*"
+description: "When creating new code, research whether existing open source packages already provide the feature before writing it from scratch."
+---
+
+## Open Source First
+
+Before writing new code from scratch, always research whether a well-maintained open source package already provides the feature. Do not blindly rewrite what the ecosystem already offers.
+
+### Research before you write
+
+- Search for existing libraries that solve the problem (npm, PyPI, crates.io, etc. depending on the ecosystem)
+- Evaluate candidates on: maintenance activity, popularity, bundle size, license compatibility, and API fit
+- Prefer battle-tested, widely-used packages over rolling your own solution
+
+### Use an existing package when
+
+- The package is actively maintained and widely adopted
+- Its license is compatible with the project
+- It covers the needed feature without excessive bloat
+- Adopting it is faster and less error-prone than writing the code yourself
+
+### Write it yourself when
+
+- No suitable package exists
+- The package is unmaintained, has incompatible licensing, or is bloated for the use case
+- The feature is a core differentiator that needs full control
+- The implementation would be trivial and adding a dependency is not justified
+
+### Modern, lightweight utility libraries
+
+- [es-toolkit](https://es-toolkit.dev) — a modern, performant, tree-shakeable alternative to lodash
+- [tailwind](https://tailwindcss.com) — a modern, performant, utility-first CSS framework
+- Look for similar focused, well-maintained alternatives in every domain before writing custom code
+
+### Rule of thumb
+
+Reuse first, write second.

package/agents/instructions/yaawn-personas.instructions.md

@@ -0,0 +1,18 @@
+---
+applyTo: "**/*"
+description: "Pick the agent persona for the task under the hood: Developer by default, Reviewer for reviews, Product Owner for work item writing."
+---
+
+## Agent Personas
+
+Before you start a task, pick the persona that fits it, read its file, and work in that persona until the task is done. Pick it yourself — never ask the user to choose a persona, and never mention the switch unless asked.
+
+| Task                                                                                                                 | Persona       | File                                      |
+| -------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------- |
+| Reviewing code, a pull request, a plan, or a diff; audits                                                            | Reviewer      | `.agents/personas/yaawn-reviewer.md`      |
+| Writing, refining, grilling (conceptual), or splitting work items (story, refactor, spike, bug report, other change) | Product Owner | `.agents/personas/yaawn-product-owner.md` |
+| Everything else — implementing, fixing, refactoring, planning, technical grilling, explaining                        | Developer     | `.agents/personas/yaawn-developer.md`     |
+
+- Developer is the default. When a task fits no other row, or a persona file is missing, work as the Developer.
+- A skill that names a persona wins over this table.
+- A persona sets the mindset only. It never overrides the user's request, `AGENTS.md`, or other instructions.

package/agents/instructions/yaawn-semantic-html.html.instructions.md

@@ -0,0 +1,40 @@
+---
+applyTo: '**/*.{html,tsx,jsx}'
+description: 'Always use semantic HTML elements instead of meaningless div or span elements. See https://web.dev/learn/html/semantic-html'
+---
+
+## Semantic HTML
+
+When creating HTML, always prefer semantic elements over meaningless `<div>` or `<span>` wrappers. Semantic HTML describes the meaning of the content to browsers, assistive technologies, and search engines.
+
+### Use the right element for the job
+
+- `<header>`, `<nav>`, `<main>`, `<article>`, `<section>`, `<aside>`, `<footer>` — for page structure
+- `<h1>`–`<h6>` — for headings, in hierarchical order (never skip levels for styling; use CSS instead)
+- `<p>` — for paragraphs of text
+- `<ul>` / `<ol>` / `<li>` — for lists
+- `<a>` — for links (use `href`, not JS click handlers, whenever navigation is the intent)
+- `<button>` — for actions (not `<div onclick>`)
+- `<form>`, `<label>`, `<input>`, `<select>`, `<textarea>` — for forms, with proper label associations
+- `<img>` with meaningful `alt` text — for images
+- `<table>`, `<thead>`, `<tbody>`, `<th>`, `<td>` — for tabular data (not for layout)
+- `<figure>` / `<figcaption>` — for self-contained content with a caption
+- `<time>` — for dates and times
+- `<blockquote>` / `<q>` / `<cite>` — for quotations
+
+### Why semantic HTML matters
+
+- **Accessibility**: screen readers and other assistive technologies rely on semantic structure to navigate and announce content
+- **SEO**: search engines understand content hierarchy and importance from semantic elements
+- **Maintainability**: code is self-documenting — the element name tells you what the content is
+- **Resilience**: semantic HTML works without CSS and degrades gracefully
+
+### Rules
+
+- Never use `<div>` or `<span>` when a semantic element exists for the purpose
+- Do not choose elements for their default styling — style semantic elements with CSS instead
+- Keep a logical heading hierarchy (`h1` → `h2` → `h3`, never skip levels)
+- Every `<img>` must have an `alt` attribute (use `alt=""` only for purely decorative images)
+- Every form input must have an associated `<label>`
+
+Reference: [web.dev — Learn HTML: Semantic HTML](https://web.dev/learn/html/semantic-html)

package/agents/instructions/yaawn-vanilla-css.css.instructions.md

@@ -0,0 +1,50 @@
+---
+applyTo: '**/*.css'
+description: 'Write vanilla CSS only, with class names following the OOCSS or BEM pattern. See https://www.frontendmentor.io/articles/understanding-css-naming-conventions-bem-oocss-smacss-and-suit-css-V6ZZUYs1xz'
+---
+
+## Vanilla CSS with OOCSS or BEM naming
+
+All CSS is hand-written vanilla CSS — no preprocessor, no utility framework, no CSS-in-JS. Class names follow the OOCSS or BEM pattern so styles stay predictable, reusable, and free of collisions.
+
+### Vanilla CSS only
+
+- Write plain `.css` files — no Sass/Less, no Tailwind or other utility-first frameworks, no CSS-in-JS
+- Keep styles in stylesheets, not in `style` attributes or JS strings
+- Keep selectors flat — nest at most one level deep, prefer class names over long descendant chains
+- Keep specificity low
+- Reserve `!important` for overriding third-party styles
+
+### Naming: OOCSS or BEM
+
+- **Pick one pattern per component and stick to it.**
+
+**OOCSS** — separate structure from skin:
+
+- Structure (layout, sizing, positioning) and skin (colors, borders, backgrounds) live in separate classes
+- Example: `class="btn btn-primary"` — `.btn` carries the structure, `.btn-primary` carries the skin
+- Reuse the structure class across components instead of repeating layout rules
+
+**BEM** — Block, Element, Modifier:
+
+- `.block` — a standalone component
+- `.block__element` — a part of the block, joined with a double underscore
+- `.block--modifier` / `.block__element--modifier` — a variant, joined with a double dash
+- Example: `.card`, `.card__title`, `.card__body`, `.card--highlighted`, `.card__title--large`
+- Reach every component through class names, not bare element selectors or IDs
+
+### Rules
+
+- Class names are lowercase kebab-case; BEM separators are `__` (element) and `--` (modifier)
+- Give each class one responsibility — split unrelated styles into separate classes
+- Scope component styles to their block or root class so components stay portable
+- Name classes after what they are, not how they look (`class="alert"`, not `class="red-box"`) — modifiers carry the variants
+
+### Why this pattern
+
+- Predictability: the name tells you the component, the part, and the variant at a glance
+- No collisions: namespaced names keep components from leaking styles into each other
+- Reusability: separating structure from skin lets you recombine them across components
+- Maintainability: flat, low-specificity selectors are easy to override and refactor
+
+Reference: [Frontend Mentor — Understanding CSS naming conventions: BEM, OOCSS, SMACSS, and SUIT CSS](https://www.frontendmentor.io/articles/understanding-css-naming-conventions-bem-oocss-smacss-and-suit-css-V6ZZUYs1xz)

package/agents/output-styles/yaawn-eli5.instructions.md

@@ -0,0 +1,45 @@
+---
+name: ELI5
+description: 'Use only when the user explicitly asks for an ELI5, beginner-level, or plainly-worded explanation. Rewrites chat prose to use analogies, everyday vocabulary, and short sentences. Changes wording only — never code, commands, or file paths.'
+keep-coding-instructions: true
+---
+
+# ELI5
+
+Explain things the way you would to someone smart who has never seen this system before.
+
+## Scope
+
+This style changes **the prose of chat answers only**. It never changes:
+
+- code, identifiers, and type names
+- file paths and shell commands
+- API names, endpoints, and configuration keys
+- error messages, stack traces, and log output
+- diffs and code comments
+- commit messages and PR descriptions
+- i18n keys and i18n values
+- anything inside a fenced code block
+
+Reproduce all of the above verbatim. Generated code follows the repository's existing conventions and is never reworded to fit this style.
+
+Accuracy outranks every rule below:
+
+- Never simplify a technical term into an inaccurate one.
+- Never shorten an error message or a security warning.
+- Never drop a caveat to make a sentence shorter.
+
+If a rule in this file would make the answer wrong, the rule loses.
+
+If another output style is also active, stop and ask which one applies.
+
+## Writing rules
+
+- Lead with an analogy or a concrete everyday comparison, then connect it back to the real thing.
+- Use everyday vocabulary. Prefer "reads" over "consumes", "goes wrong" over "fails to resolve".
+- Keep sentences short. One idea per sentence.
+- Introduce every technical term the first time it appears: name it, then say what it does in plain words.
+- Prefer concrete examples over abstract description.
+- Say what something is _for_ before saying how it works.
+- Do not use jargon as a shortcut. If a term is unavoidable, explain it.
+- Keep the answer as short as the question allows. Simple is not the same as long.

package/agents/personas/yaawn-developer.md

@@ -0,0 +1,16 @@
+# Persona: Developer
+
+The default persona. Wear it for every task that no other persona claims — implementing, fixing, refactoring, technical grilling of an implementation design, explaining code, running the plan pipeline.
+
+## Mindset
+
+- Deliver working, tested code — not a sketch, not a suggestion.
+- Follow the team's definition of done in `.yaawn/yaawn-definition-of-done.md` and the instructions that apply to the files you touch.
+- Keep changes small and surgical; leave the code a little cleaner than you found it.
+- Bake security in while you write — load the `yaawn-owasp-security` lens; never leave it as a follow-up note.
+- Prove it works: add or update the tests that cover the change.
+
+## Avoid
+
+- Unrequested features, speculative abstractions, or rewrites of code you were not asked to touch.
+- Declaring work done before it is verified.

package/agents/personas/yaawn-product-owner.md

@@ -0,0 +1,18 @@
+# Persona: Product Owner
+
+Wear it for writing, refining, conceptually grilling, or splitting work items — stories, refactors, spikes, and bug reports — the what, never the how.
+
+## Mindset
+
+- Start from value: who benefits, what changes for them, and why it matters now.
+- Write stories from the product's user roles in `.yaawn/yaawn-user-roles.md`; with none listed, write for the Developer.
+- Hold every story to INVEST — independent, negotiable, valuable, estimable, small, testable.
+- Make acceptance criteria sharp: observable outcomes a non-developer can verify.
+- Give every other type its own sharp fields: a refactor's goal and done means, a spike's one question, timebox, and exit criteria, a bug's steps to reproduce and current versus expected behavior.
+- Prefer thin vertical slices that ship value early.
+
+## Avoid
+
+- Implementation details, file names, or code in any work item.
+- Generic "As a user" stories.
+- Forcing a refactor, spike, or bug report into story shape — no persona, no "As a … I want …".

package/agents/personas/yaawn-reviewer.md

@@ -0,0 +1,16 @@
+# Persona: Reviewer
+
+Wear it for every review — code review, pull request review, plan review, or audit.
+
+## Mindset
+
+- Review like a staff engineer: judge correctness, design, security, and maintainability, not taste.
+- Flag only what matters — bugs, logic errors, security risks, missing tests, broken contracts. Skip style nits a linter would catch.
+- Be specific: name the file and line, explain the impact, and propose a concrete fix.
+- Rank findings by severity so the most important ones come first.
+- Say clearly when something is good enough to ship.
+
+## Avoid
+
+- Rewriting the change yourself instead of giving feedback.
+- Vague remarks ("this could be better") without a reason or a fix.

package/agents/skills/yaawn-clean-code/SKILL.md

@@ -0,0 +1,61 @@
+---
+name: yaawn-clean-code
+description: "Clean Code rules based on Robert C. Martin's book. Use when: reviewing code quality, naming variables/functions/classes, refactoring long functions, reducing complexity, improving readability, writing clean tests, handling errors, formatting code, detecting code smells, applying SOLID/DRY/KISS/YAGNI principles, code review feedback."
+user-invocable: false
+context: fork
+metadata:
+  github-repo: https://github.com/markusfalk/yaawn
+  author: markusfalk
+---
+
+# Clean Code Rules
+
+Provides clean code rules and guidelines based on Robert C. Martin's _Clean Code: A Handbook of Agile Software Craftsmanship_, distilled from the [gpcoder gitbook summary](https://gpcoder.gitbook.io/clean-code) and adapted for TypeScript.
+
+This skill **complements** the always-on [yaawn-clean-code.typescript.instructions.md](../../../.agents/instructions/yaawn-clean-code.typescript.instructions.md) which provides a lightweight summary. Use this skill for deeper guidance on specific topics.
+
+## When to Use
+
+- **Code review**: Evaluating naming, function size, class design, comment quality
+- **Refactoring**: Breaking down large functions/classes, removing duplication, improving readability
+- **Design decisions**: Choosing between data structures vs objects, error handling strategies, abstraction levels
+- **Test quality**: Writing clean, readable, independent tests following F.I.R.S.T. principles
+- **Code smell detection**: Identifying rigidity, fragility, immobility, needless complexity, opacity
+
+## Topic Routing Table
+
+Identify which topic(s) are relevant to the user's question, then load **only** the matching reference file(s).
+
+| Topic Keywords                                                                                                                                                                                   | Reference File                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
+| naming, variables, functions, classes, intention-revealing, pronounceable, searchable, encodings, prefixes, context, disinformation                                                              | [meaningful-names.md](./references/meaningful-names.md)                           |
+| functions, small, do one thing, abstraction level, stepdown rule, nesting, negative conditionals, switch, polymorphism, arguments, flag arguments, side effects, command-query, error codes, DRY | [functions.md](./references/functions.md)                                         |
+| classes, organization, encapsulation, small classes, god class, SRP, cohesion, SOLID, patterns                                                                                                   | [classes.md](./references/classes.md)                                             |
+| comments, self-documenting, JSDoc, redundant comments, misleading, TODO, journal comments, noise, commented-out code                                                                             | [comments.md](./references/comments.md)                                           |
+| error handling, exceptions, try-catch, typed errors, null, undefined, fail fast, error context, wrapper errors                                                                                   | [error-handling.md](./references/error-handling.md)                               |
+| tests, unit tests, readability, one assert, single concept, F.I.R.S.T., fast, independent, repeatable, self-validating, timely, AAA, given-when-then                                             | [unit-tests.md](./references/unit-tests.md)                                       |
+| formatting, vertical, horizontal, whitespace, density, openness, indentation, team rules, dependent functions                                                                                    | [formatting.md](./references/formatting.md)                                       |
+| objects, data structures, abstraction, anti-symmetry, hybrids, Law of Demeter, DTO, encapsulation                                                                                                | [objects-and-data-structures.md](./references/objects-and-data-structures.md)     |
+| simple design, code smells, duplication, expressiveness, rigidity, fragility, immobility, opacity, dead code, feature envy                                                                       | [simple-design-and-code-smells.md](./references/simple-design-and-code-smells.md) |
+| SOLID, SRP, OCP, LSP, ISP, DIP, KISS, DRY, YAGNI, Boy Scout Rule, design patterns, coding conventions                                                                                            | [principles.md](./references/principles.md)                                       |
+
+## Quick Decision Guide
+
+| Question                                   | Answer                                    |
+| ------------------------------------------ | ----------------------------------------- |
+| Is a name unclear?                         | Load **meaningful-names.md**              |
+| Is a function too long or doing too much?  | Load **functions.md**                     |
+| Is a class too large or unfocused?         | Load **classes.md**                       |
+| Should I add a comment?                    | Load **comments.md** — probably not       |
+| How should I handle this error?            | Load **error-handling.md**                |
+| Are my tests clean and maintainable?       | Load **unit-tests.md**                    |
+| Is the code layout hard to follow?         | Load **formatting.md**                    |
+| Should this be a class or a plain object?  | Load **objects-and-data-structures.md**   |
+| Something feels wrong but I can't name it? | Load **simple-design-and-code-smells.md** |
+| Which principle applies here?              | Load **principles.md**                    |
+
+## Gotchas
+
+- **Repo conventions override book conventions**: Where the book's advice conflicts with this codebase's explicit conventions (e.g. `AGENTS.md`, `*.instructions.md`), prefer the repo convention and flag the discrepancy. For example: the book has no rule against `$` suffixes on Observables, but this repo explicitly forbids them.
+- **Constants**: Clean Code does not mandate ALL_CAPS for constants. This repo explicitly uses camelCase for constants (e.g. `const maxRetries = 3`, not `const MAX_RETRIES = 3`).
+- **Comments**: The default is no comment. See the Comments section of `AGENTS.md` before adding one — the tagging convention there applies only to comments that have already earned their place, and is never a reason to write one.

package/agents/skills/yaawn-clean-code/references/classes.md

@@ -0,0 +1,114 @@
+# Classes
+
+Classes should be small and have a single responsibility.
+
+> Source: Robert C. Martin, _Clean Code_ — Chapter 10: Classes
+
+## Rules
+
+### Class organization
+
+Follow a consistent ordering within a class (adapted for TypeScript):
+
+1. Static properties
+2. Instance properties (public → protected → private)
+3. Constructor
+4. Framework lifecycle hooks (e.g. `ngOnInit`, `componentDidMount`), if the framework has them
+5. Public methods
+6. Private methods — **grouped by functionality**, not by access level. A private helper should appear directly below the public method that calls it.
+
+```typescript
+// Good — private helpers are near their callers
+class UserService {
+  doSomething1(): void {
+    this.task1();
+    this.task2();
+  }
+
+  private task1(): void {}
+  private task2(): void {}
+
+  doSomething2(): void {
+    this.task3();
+  }
+
+  private task3(): void {}
+}
+```
+
+### Encapsulation
+
+Prefer private members. Only expose what is needed. Sometimes a member must be `protected` for testability — that's acceptable.
+
+### Classes should be small
+
+The name of a class should describe its responsibility. If you cannot derive a **concise name**, the class is likely too large. Names including `Manager`, `Processor`, `Super`, `Common`, `Helper` often hint at too many responsibilities.
+
+You should be able to describe a class in about **25 words** without using "if", "and", "or", or "but".
+
+```typescript
+// Bad — does too many unrelated things
+class CommonUtils {
+  static toJson(obj: unknown): string {
+    /* ... */
+  }
+  static fromJson<T>(json: string): T {
+    /* ... */
+  }
+  static concat(delimiter: string, ...parts: string[]): string {
+    /* ... */
+  }
+  static isNotBlank(str: string): boolean {
+    /* ... */
+  }
+  static randomString(length: number): string {
+    /* ... */
+  }
+}
+
+// Good — each class has a single focus
+class JsonUtils {
+  static toJson(obj: unknown): string {
+    /* ... */
+  }
+  static fromJson<T>(json: string): T {
+    /* ... */
+  }
+}
+
+class StringUtils {
+  static concat(delimiter: string, ...parts: string[]): string {
+    /* ... */
+  }
+  static isNotBlank(str: string): boolean {
+    /* ... */
+  }
+}
+```
+
+### Avoid god classes
+
+A god class concentrates too many responsibilities, controls too many objects, and does everything. Problems:
+
+- Violates SOLID
+- Makes code fragile
+- Harms testability
+- Harms performance
+- Makes code harder to understand
+
+### Single Responsibility Principle (SRP)
+
+A class should have **one, and only one, reason to change**. This is the most important principle for class design. See [principles.md](./principles.md) for the full SOLID breakdown.
+
+### Cohesion
+
+Classes should be cohesive — a class's methods should manipulate its instance variables. The more variables a method uses, the more cohesive it is. When cohesion drops, split the class.
+
+**High cohesion:** Every method uses most instance variables.
+**Low cohesion:** Methods form separate groups that each touch different variables → split into multiple classes.
+
+### Follow SOLID principles and design patterns
+
+- **SOLID**: SRP, OCP, LSP, ISP, DIP — see [principles.md](./principles.md)
+- **Law of Demeter**: Don't chain calls through collaborators — see [objects-and-data-structures.md](./objects-and-data-structures.md)
+- **Design Patterns**: Use established patterns (Strategy, Observer, Factory, etc.) when they simplify the design

package/agents/skills/yaawn-clean-code/references/comments.md

@@ -0,0 +1,164 @@
+# Comments
+
+**Comments are the exception, not the rule.** Do not write comments. The code must speak for itself.
+
+> Source: Robert C. Martin, _Clean Code_ — Chapter 4: Comments
+
+## The Rule (non-negotiable)
+
+**An LLM MUST NOT add any explanatory comment to code without explicit user approval.**
+
+Before adding any comment that explains intent, clarifies, or warns, the LLM must:
+1. Stop
+2. Ask the user: "I want to add a comment explaining [reason]. Is this OK?"
+3. Wait for explicit user confirmation
+4. Only then proceed
+
+This is human-in-the-loop. No exceptions.
+
+## When a Comment is Allowed (only if user approves)
+
+### Legal comments
+
+Copyright and licensing notices required by corporate standards. These do not require user approval as they are non-negotiable legal requirements.
+
+### Explanation of intent (requires user approval)
+
+Only when the **why** cannot be expressed in code and the cost of misunderstanding is severe.
+
+```typescript
+/**
+ * AI COMMENT: We use a large number of concurrent requests here
+ * to stress-test the race condition we observed in production.
+ * @author AI Assistant
+ */
+```
+
+### Warning of consequences (requires user approval)
+
+Only when the consequence is non-obvious and severe (security, data loss, production outage).
+
+### TODO comments (requires user approval)
+
+Only for critical work that blocks progress. Prefer creating a tracked issue instead.
+
+### JSDoc for public APIs (requires user approval)
+
+Only for the public API a domain exposes to other domains — not for internal code.
+
+## When a Comment is NEVER Allowed
+
+### Redundant comments
+
+A comment that describes something the code already describes itself.
+
+```typescript
+// Bad — the name already says it
+/** Create a directory */
+function createDirectory(name: string): void {}
+
+// Bad — property names are self-documenting
+interface ContainerBase {
+  /** The background processor delay for this component. */
+  backgroundProcessorDelay: number;
+}
+```
+
+### Misleading comments
+
+Comments that don't accurately describe the code's behavior. A reader who believes the comment may misuse the function.
+
+### Mandated comments
+
+Rules that force a JSDoc on every function/variable just clutter the code. Only document what adds value.
+
+### Journal comments
+
+Change logs at the top of files. Source control handles this — remove them.
+
+### Noise comments
+
+Comments that restate the obvious add no value.
+
+```typescript
+// Bad
+/** Default constructor. */
+constructor() {}
+
+/** The day of the month. */
+private dayOfMonth: number;
+
+/** Returns the day of the month. */
+getDayOfMonth(): number { return this.dayOfMonth; }
+```
+
+### Use a function or variable instead of a comment
+
+If you need a comment to explain a complex expression, extract it into a well-named variable or function.
+
+```typescript
+// Bad
+// does the module from the global list depend on the subsystem we are part of?
+if (smodule.getDependSubsystems().includes(subSysMod.getSubSystem())) {
+}
+
+// Good
+const moduleDependees = smodule.getDependSubsystems();
+const ourSubSystem = subSysMod.getSubSystem();
+if (moduleDependees.includes(ourSubSystem)) {
+}
+```
+
+### Position markers / section dividers
+
+```typescript
+// Bad
+/////////////////////////////////////////////////
+// PROPERTIES, PRIVATE AND PROTECTED
+/////////////////////////////////////////////////
+```
+
+These are clutter. If your class is so large it needs section dividers, the class is too large.
+
+### Closing brace comments
+
+If you need to mark closing braces, shorten your functions instead.
+
+### HTML in comments
+
+Makes comments hard to read in the editor. Avoid.
+
+### Commented-out code
+
+**Delete it.** Source control remembers. Commented-out code accumulates and no one dares to delete it because they assume someone needed it.
+
+### Too much information
+
+Don't put historical discussions, RFCs, or irrelevant technical details in comments.
+
+### Function headers that duplicate the name
+
+A well-named small function doesn't need a comment header.
+
+```typescript
+// Bad
+/** Save product only, if not a product throw a ClassCastException */
+function save(obj: unknown): void {}
+
+// Good
+function saveProduct(product: Product): void {}
+```
+
+### Systemwide information in local comments
+
+A comment should describe the code near it, not global configuration or defaults defined elsewhere.
+
+## The Test
+
+If you can name a function, variable, or type to make the code clear, **do that instead of commenting.**
+
+If the comment explains **what** the code does, **delete it.**
+
+If the comment does not explain a **why** that cannot be expressed in code, **delete it.**
+
+If you are an LLM and did not ask the user before adding an explanatory comment, **you violated this rule.**