Skip to content

Clarify comment review rules for agents and contributors - #5

Merged
wireindevice merged 1 commit into
mainfrom
docs/comment-review-rules
Nov 3, 2026
Merged

wireindevice merged 1 commit into
mainfrom
docs/comment-review-rules

Conversation

@wireindevice

Copy link
Copy Markdown
Member
  • Add a repository-local AGENTS.md entry point so coding agents read the same contribution and quality rules as developers.
  • Require final-diff review for redundant comments/docstrings; retain concise non-obvious rationale, public contracts and required directives. Link the rule from existing contributor and engineering guidance.
  • Preserve repository scope and existing quality gates; no runtime behavior, test assertions, dependency pins or release publication changed.

Validation

  • make release-check — passed.
  • git diff --check — passed.
  • Changed Markdown links, anchors, scope and final diff reviewed.

@wireindevice
wireindevice merged commit 88b8d3f into main Nov 3, 2026
1 check passed
@wireindevice
wireindevice deleted the docs/comment-review-rules branch November 3, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant