Instruction file imported from Kento-E/discord-ai-chatbot (
.github/instructions/general.instructions.md). Copyright stays with the author.
Copilot・自動生成ツール向け 全般指示
このプロジェクトで作業する際は、以下のルールを厳守してください。
言語設定
- すべての出力は日本語で行うこと
- コミットメッセージは日本語で記述すること
- PR のタイトルは日本語で記述すること
- PR の Description(説明文)は日本語で記述すること
- コード内のコメントを追加する場合も日本語で記述すること
コミットハッシュの表記ルール
- コミットハッシュは必ず前後に半角スペースを入れて素のまま記載すること(例: ...修正は 778aa44 で対応済み)
- Markdown リンクやインラインコード、引用、装飾は一切使わないこと
- 7 文字以上の 16 進英数字のみを使い、コミットハッシュとして認識できる形式にすること
- 例: ...修正は 778aa44 で対応済み
- 誤: ...修正は778aa44で対応済み
- 誤: ...修正は
778aa44で対応済み - GitHub は半角スペースで区切られたコミットハッシュを自動でリンク化するため、装飾は不要
- Copilot や自動生成ツールもこのルールを厳守すること
PR 説明文の更新
- PR 説明文を更新する際は、既存の HTML コメントを必ず保持すること
- 特に
<!-- for GitHub Copilot review rule -->で囲まれた部分は絶対に削除しないこと - PR テンプレートの区切り線(
---)以降の内容は常に保持すること
- 特に
report_progressツールを使用する際の注意- PR テンプレートの HTML コメントを含めた完全な説明文を渡すこと
- 説明文の最後に必ず以下の形式でテンプレートのコメントを含めること:
## 変更内容
(あなたの説明文)
<!-- ここにPRの説明を記載してください -->
<!-- 以下の区切り線とコメントは削除・変更しないでください -->
---
<!-- for GitHub Copilot review rule -->
<!--
必ず、日本語でレビューしてください。レビュー結果を日本語で記載してください。
PRのタイトルを修正すべきであれば指摘してください。
-->
<!-- for GitHub Copilot review rule -->
このファイルは Copilot および自動生成ツール向けの全般的な指示です。