Issueの作成
ユーザーの説明($ARGUMENTSと会話)に基づいて、issueのテキストを準備します。
ユーザーはこのテキストを課題管理システムにコピーし、そこでissueを作成し、担当者、優先度、バージョンなどを設定します。
このスキルは課題管理システム上でissueを作成しません。
課題管理システム:読み取り専用
課題管理システム(Redmine、GitHub、GitLab)では、エージェントはissueを読み取ることしかできません。 決して変更してはなりません。たとえユーザーが依頼してもダメです:
- 作成、編集、クローズ、再オープン、削除は禁止;
- コメント、ノート、添付ファイル、作業時間の追加は禁止;
- ステータス、担当者、優先度、バージョン、ラベルの変更は禁止。
読み取りリクエストのみ使用:-Xもデータも付けないcurl(つまりGET)、
gh issue view、gh issue list。POST、PUT、PATCH、DELETEは決して使用しない。
また、gh issue create、edit、comment、close、reopen、deleteのようなコマンドも禁止。
管理システムにテキストを入力する必要がある場合は、issues/内のファイルに書き込む:
ユーザーがそれをコピーする。
1. issuesディレクトリ
プロジェクトのルート(gitリポジトリのルート,存在する場合)に
issues/ディレクトリが存在し、その中に自分自身以外のすべてを無視する
.gitignoreがなければなりません:
*
!.gitignore
ディレクトリまたは.gitignoreがない場合は、それらを作成します。
.gitignoreが異なる内容で存在する場合は、変更せずにユーザーに通知します。
2. 情報の収集と確認
- リクエストを分類します:バグ、機能、またはタスク (メンテナンス、アップデート、リファクタリング、ドキュメント...)。
- 説明内容をプロジェクトのコードで検証します:言及されたファイル、クラス、 ルート、テーブル、動作を検索し、それらが存在し説明通りに動作することを確認します。 関連するファイルをメモします。
- 欠落または曖昧な情報を特定します。例えば:
- バグ:再現手順、期待される動作と実際の動作、環境(本番、ステージング、ローカル)、 エラーメッセージまたはログ;
- 機能:誰が使うか、何ができるべきか、エッジケース、制約;
- すべてに共通:issueが解決されたと見なす基準。
- 必要な情報が不足している場合、またはコードが説明と一致しない場合は、 書き込む前にユーザーに質問します。質問はすべて一度に行い、本当に必要なものだけにします。
解決策を提案したり実装したりしないでください:issueは問題と期待される結果を記述します。 技術ノートは、それに取り組む人のための方向付けのみを目的とします。
3. ファイルの作成
issues/<YYYY-MM-DD>-<slug>.mdというファイルを作成します。slugはタイトルを小文字にし、
単語を-で区切り、特殊文字を含めない(最大50文字)。
ファイルがすでに存在する場合は、サフィックス-2、-3...を追加します。
ファイルの構造:
# <簡潔で具体的なタイトル>
## コンテキスト
[問題やタスクがどこに位置づけられるか、なぜ必要なのか。]
## 説明
[バグ:現在の動作。機能/タスク:何をすべきか。]
## 再現手順
1. [...]
## 期待される動作
[...]
## 受け入れ基準
- [ ] [検証可能な条件]
## 技術ノート
- `path/to/file` — [なぜ関連するか]
## 参照
- [リンク、関連issue、ログ、スクリーンショット]
ルール:
- 再現手順はバグのみ;期待される動作はバグと機能の両方。 技術ノートと参照は空の場合は省略。
# タイトル行は管理システムのタイトルフィールドに入ります;残りは##見出し以下が 説明に入ります。- 形式はCommonMark;コードとログは言語指定付きのコードブロック。
- 言語:日本語。絵文字は使用しない。
- 会話に参加していない人にも理解できる簡潔なテキスト:「上記の通り」やセッションへの 参照は避ける。
4. ユーザーへの応答
以下の内容を示します:
- 作成したファイルのパス;
- 提案されたタイトルとタイプ(バグ、機能、タスク);
- 管理システムでissueを作成した後、ファイル名にissue番号を含めるようリネームすることを推奨
(例:
issues/123-<slug>.md):これにより、管理システムにアクセスできなくてもopen-issue 123で見つけられます。