docs: require README updates alongside CLI changes

[alexeyzimarev]

Summary

Adds a CLAUDE.md note (under Common mistakes to avoid) instructing future contributors — human and AI — to update README.md in the same PR as any user-facing CLI change.

The trigger: AI-613 (PR #58) and AI-70 (PR #55) both shipped substantial CLI surface changes without touching README.md, requiring follow-up doc-only PRs (#60 and #61). The new bullet:

• names the kinds of changes that require a README update (new command, new/renamed/removed flag, default-behavior shift, new prerequisite)
• points at the two README sections that typically need touching (## Getting started quick-start and ## CLI commands per-command sections)
• calls out that updating only src/Kapacitor.Core/Resources/help-*.txt isn't enough — --help output is internal, the README is the public docs.

Test plan

• Diff reviewed — single bullet appended to existing list, no other changes.
• Validate next CLI-touching PR includes README updates (the test of whether this note actually helps).

🤖 Generated with Claude Code

[qodo-code-review]

Review Summary by Qodo

Document requirement to sync README with CLI changes

📝 Documentation

Walkthroughs

Description

• Adds guidance for CLI changes requiring README updates
• Specifies sections to update in README.md
• References past follow-up PRs caused by missing docs
• Clarifies help-*.txt files insufficient for public docs

Diagram

flowchart LR
  CLI["CLI Surface Changes"]
  README["README.md Updates"]
  SECTIONS["Quick-start & Commands"]
  CLI -- "must update" --> README
  README -- "check sections" --> SECTIONS

Loading

File Changes

1. CLAUDE.md 📝 Documentation +1/-0

Add CLI-to-README sync requirement guidance

• Adds new bullet point to "Common mistakes to avoid" section
• Documents requirement to update README.md alongside CLI changes
• Specifies which README sections need updates (Getting started, CLI commands)
• Clarifies that help-*.txt resources are insufficient for public documentation
• References previous follow-up PRs (#60, #61) caused by missing updates

CLAUDE.md

---