Skip to content

docs: keep comments to intent the code cannot show - #45

Merged
shin4488 merged 1 commit into
mainfrom
docs/agents-comment-guidelines
Oct 4, 2026
Merged

shin4488 merged 1 commit into
mainfrom
docs/agents-comment-guidelines

Conversation

@shin4488

@shin4488 shin4488 commented Oct 4, 2026

Copy link
Copy Markdown
Owner

変更

  • AGENTS.mdの「Working approach」に、コメントにはコードから読み取れない意図・前提だけを書き、経緯・変わりやすい値・他の資料の場所など、変更のたびに古くなる内容は書かないという規約を追加しました。
  • 同じ趣旨の既存の記載(判断理由・意図をコメントに書く旨)を削り、重複をなくしました。

検証

  • 文書だけの変更のため、差分とMarkdownの記法を確認しました。アプリの動作に影響しないため、ビルド・テストは実行していません。

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@shin4488
shin4488 merged commit 0488df0 into main Oct 4, 2026
5 checks passed
@shin4488
shin4488 deleted the docs/agents-comment-guidelines branch October 4, 2026 08:17
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