docs: AGENTS.md にブランチ命名規則とマージ済みPRの扱いを追加 - #4518
Merged
Merged
Conversation
#4515 で追加したブランチ運用・コミット作成のルールに、運用上必要となった 以下の3点を追記する。 - トピックブランチ名には種別 prefix（fix/ feature/ security/ docs/）を付ける fix/ と security/ は既存ブランチで実際に使われている慣習に合わせ、 feature/ と docs/ を追加した - AI ツールが自動生成した作業ブランチ名（claude/... など）をそのまま使うのは、 そのセッションでブランチを指定された場合のみとする - AI が関与したことの明示（Co-Authored-By、生成ツール表記）は残す エージェントは GitHub へ操作者本人のアカウントで書き込むため、これらの表記が AI による記述かを読み手が判別する手がかりとなる あわせて、マージ済みのプルリクエストへ追加コミットをプッシュしてしまい変更が 反映されない事例が発生したため、プッシュ前にマージ状態を確認し、追加の変更は 新しいトピックブランチと別のプルリクエストとして起票することを明記した。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
ドキュメント更新のみであり、指摘は軽微な表現の明確化に留まるため。
Pull request overview
AI エージェント向け開発指示書 AGENTS.md の運用ルールを補強し、ブランチ命名規則とマージ済み PR の取り扱い、AI 関与明示の方針を明確化する PR です。
Changes:
- プッシュ前に「対象 PR がマージ済みか」を確認し、追加変更は新規 PR で行うルールを追記
- トピックブランチ命名の prefix 規約（
fix/,feature/,security/,docs/）を明文化 - AI 関与の明示（
Co-Authored-By:や生成ツール表記）について説明を具体化
File summaries
| File | Description |
|---|---|
| AGENTS.md | ブランチ運用・命名規則、マージ済みPR対応、AI関与明示のガイドラインを追記・明確化 |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - `security/` … セキュリティ対応 | ||
| - `docs/` … ドキュメントのみの変更 | ||
|
|
||
| prefix に続けて、内容が分かる名前を英小文字ハイフン区切りで付ける。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
#4515 で追加した「ブランチ運用時の注意」「コミット・プルリクエスト作成時の注意」に、運用上必要となった項目を追記しました。
変更内容
1. トピックブランチの命名規則を追加
fix/とsecurity/は既存ブランチ（fix/setup-script-wait-hang、security/preview-status-disclosureなど）で実際に使われている慣習に合わせ、feature/とdocs/を追加する形にしています。あわせて、AI ツールが自動生成した作業ブランチ名（
claude/...など）をそのまま使うのは、そのセッションでブランチを指定された場合のみとし、エージェントが新規にブランチを切る場合は上記の種別 prefix を使うことを明記しました。2. マージ済みプルリクエストの扱いを追加
マージ済みのプルリクエストへ追加コミットをプッシュしてしまい、変更が反映されない事例が発生しました。マージ済みのプルリクエストは新しいコミットを追跡できないため、以下を明記しています。
3. AI 関与の明示についての記述を明確化
従来の「
Co-Authored-By:による AI の明示は記載してよい」を、コミットのCo-Authored-By:に加えてプルリクエスト本文やコメント末尾の生成ツール表記も含む形に広げました。エージェントは GitHub へ操作者本人のアカウントで書き込むため、これらの表記がレビュアーにとって「AI による記述か」を判別する手がかりになる、という理由も添えています。
影響範囲
ドキュメントのみの変更で、プログラムコードへの影響はありません。
🤖 Generated with Claude Code
Generated by Claude Code