docs(claude/memory): capture PR-review comment-style feedback #72

Merged
lyrathorpe merged 1 commits from docs/claude-memory-pr-comment-style into main 2026-07-14 16:42:22 +01:00
Owner

Reviewed my PR comments across multicluster and unified-helm from the past two months and distilled the recurring reviewer feedback into memory.

  • code_comment_style (new): no Jira/ticket IDs in code comments by default; comment the non-obvious "why", not the obvious "what"; keep comments short and readable; in Helm use # (not {{/* */}}) for comments that must reach the rendered manifest.
  • copilot_review_false_positives (new): verify Copilot "this breaks X" claims against the spec and live config before acting; records two Terraform false positives (HCL hyphenated map keys, aks_pools count.index indexing).
  • workflow_review_and_comments (corrected): dropped the "one-liner + WSP ticket reference" rule, which reviewers repeatedly strip; now points at code_comment_style.

Docs-only; nix fmt clean.

Reviewed my PR comments across multicluster and unified-helm from the past two months and distilled the recurring reviewer feedback into memory. - code_comment_style (new): no Jira/ticket IDs in code comments by default; comment the non-obvious "why", not the obvious "what"; keep comments short and readable; in Helm use `#` (not `{{/* */}}`) for comments that must reach the rendered manifest. - copilot_review_false_positives (new): verify Copilot "this breaks X" claims against the spec and live config before acting; records two Terraform false positives (HCL hyphenated map keys, aks_pools count.index indexing). - workflow_review_and_comments (corrected): dropped the "one-liner + WSP ticket reference" rule, which reviewers repeatedly strip; now points at code_comment_style. Docs-only; nix fmt clean.
lyrathorpe added 1 commit 2026-07-14 16:41:17 +01:00
Add two memories and correct one existing, from a review of PR comments
across multicluster and unified-helm over the past two months:

- code_comment_style: no Jira/ticket IDs in code comments by default,
  keep comments concise and about the non-obvious why, and use # (not
  Helm template) comments where they must reach the rendered manifest.
- copilot_review_false_positives: verify Copilot blocking claims against
  the spec and live config before acting; records two Terraform FPs.
- workflow_review_and_comments: drop the now-contradicted 'one-liner +
  WSP ticket reference' guidance, which reviewers repeatedly strip.
lyrathorpe scheduled this pull request to auto merge when all checks succeed 2026-07-14 16:41:36 +01:00
lyrathorpe merged commit 0ff75654ce into main 2026-07-14 16:42:22 +01:00
lyrathorpe deleted branch docs/claude-memory-pr-comment-style 2026-07-14 16:42:22 +01:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: lyrathorpe/nixfiles#72