Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# quantitative-data-analysis-rs Copilot インストラクション(初版)

## 目的と前提

- 本プロジェクトはRustによる株価・財務指標分析ツール(README参照)。ヘキサゴナルアーキテクチャを崩さず、`domain`/`use_case`
でロジック、`infrastructure`/`presenter`で外部適合を行う。

## 開発ガイドライン

このプロジェクトはMicrosoftのPragmatic Rust Guidelinesに従います。

### Quick Reference

- Complete guidelines: `~/rust-guidelines.txt`
- Focus areas: Error handling, API design, performance, interoperability
- Tools: rustfmt, clippy, cargo-audit

### Code Review Checklist

- [ ] Follows error handling patterns from guidelines
- [ ] API design is scalable and idiomatic
- [ ] Performance considerations addressed
- [ ] Proper documentation and examples included

### AI Assistant Integration

When using AI coding assistants, reference the guidelines file:
"Please follow the Microsoft Rust guidelines in `~/rust-guidelines.txt`"

## コミュニケーション

- 非自明なアルゴリズムやデータ変換を触る際は簡潔なコメントで意図を共有。冗長な説明は避ける。
- 実行結果や差分を示す際はファイルパスをバッククオートで明示し、必要に応じて再現コマンドも提示。
- 不確実な点や既存の変更がある場合は、即座にユーザへ確認を取りながらペアプロする姿勢を保つ。

## 参照スキルガイド (Skills)

特定のタスクを実行する際は、必ず以下の対応するドキュメントを参照し、その指針に従ってください。

- **coding-standards**
- Rust コード変更時の設計指針・レビュー前手順
- 📄 `.github/skills/coding-standards/SKILL.md`
- **testing-practices**
- テスト実行順序・品質ゲート・ログ共有手順
- 📄 `.github/skills/testing-practices/SKILL.md`
62 changes: 62 additions & 0 deletions .github/instructions/code-review.instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
applyTo: "**/*"
excludeAgent: "coding-agent"
---

# code-review instructions

## 目的

- 本リポジトリのコードレビューで、バグ・回帰・設計崩れを早期に検知する。
- 指摘は再現性と修正方針が分かる形で提示し、手戻りを減らす。

## レビュー時の基本姿勢

- まず重大度順に指摘を列挙する(Critical/High/Medium/Low)。
- 概要説明は最後に短くまとめる。指摘がない場合は明示する。
- 推測で断定せず、根拠(コード位置、想定実行経路、テスト観点)を添える。

## 必須チェック項目

1. **正しさ/回帰**
- 境界値、null相当、空配列、0件データ、例外経路を扱えているか。
- 既存の振る舞いを壊す変更がないか(互換性、入出力形式、公開API)。
2. **アーキテクチャ整合**
- ヘキサゴナル境界を維持できているか。
- ロジックが `domain`/`use_case`、外部適合が `infrastructure`/`presenter` に分離されているか。
3. **Rust品質**
- `unwrap`/`expect` の乱用がないか(テスト・初期化を除く)。
- `Result` とエラー型で失敗が明示され、エラー文脈が不足していないか。
- 不要な `clone` や過剰アロケーションがないか。
4. **テスト妥当性**
- 変更に対応するユニット/統合テストが追加・更新されているか。
- 失敗ケース・境界ケースを検証しているか。
5. **可読性/保守性**
- 命名が意図を表しているか。
- 複雑な処理に最小限の補助コメントがあるか。

## レビューコメントの書き方

- 1指摘につき以下を含める:
- 重大度
- 対象ファイルと行(例: `src/use_case/interactors/...:42`)
- 何が問題か
- なぜ問題か(実害/将来リスク)
- 修正案(短く具体的に)

## 出力テンプレート

- Findings
- `[Severity] path:line` 問題点、影響、修正案
- Open Questions / Assumptions
- 仕様不明点や確認事項
- Final Note
- 指摘なしの場合は「重大な指摘なし」。
- 残留リスクや未実施テストがあれば明記。

## 参照ドキュメント

- `.github/copilot-instructions.md`
- `.github/skills/coding-standards/SKILL.md`
- `.github/skills/testing-practices/SKILL.md`
- `~/.rust/rust-guidelines.txt`
56 changes: 56 additions & 0 deletions .github/prompts/code-review.prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
mode: agent
description: PRレビュー時に概要把握と内容確認の見逃しを防ぐための、チェックリスト連動プロンプト
---

# PR コードレビュー

レビュー対象の差分(または変更ファイル一覧)を提示してください。
以下の手順に沿ってレビューを実施し、所定テンプレートで結果を出力します。

## レビュー手順

### Step 1 — 変更概要の把握

- 変更の目的・背景をコミットメッセージや PR 説明から読み取る。
- 変更規模(追加/削除行数、影響モジュール)を確認する。
- ヘキサゴナル境界(`domain`/`use_case`/`infrastructure`/`presenter`)のどの層が触れられているかを特定する。

### Step 2 — チェックリストの実施

`.github/instructions/code-review.instructions.md` の「必須チェック項目」を順に確認する。

- [ ] **正しさ/回帰**: 境界値・null相当・空配列・0件データ・例外経路
- [ ] **アーキテクチャ整合**: ヘキサゴナル境界、レイヤ分離
- [ ] **Rust品質**: `unwrap`/`expect` の乱用、`Result` とエラー文脈、不要な `clone`
- [ ] **テスト妥当性**: 対応するユニット/統合テストの有無、失敗ケースの網羅
- [ ] **可読性/保守性**: 命名の意図明確さ、複雑処理への補助コメント

### Step 3 — 結果の出力

下記テンプレートに沿って出力する。

---

## Findings

<!-- 重大度順(Critical → High → Medium → Low)で列挙。指摘がなければ「なし」と記載。 -->
<!-- 書式: [Severity] `path/to/file.rs:行番号` — 問題点 / 影響 / 修正案 -->

## Open Questions / Assumptions

<!-- 仕様不明点、動作確認が取れていない箇所、前提として置いた仮定を列挙。 -->

## Final Note

<!-- 全体評価を1〜3文で。重大な指摘なしの場合はその旨を明記。残留リスクや未実施テストがあれば記載。 -->

---

## 参照ドキュメント

- `.github/instructions/code-review.instructions.md`
- `.github/skills/coding-standards/SKILL.md`
- `.github/skills/testing-practices/SKILL.md`
- `~/.rust/rust-guidelines.txt`

51 changes: 51 additions & 0 deletions .github/skills/coding-standards/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: coding-standards
description: Rust の設計原則と品質ゲートを一貫適用し、ヘキサゴナル境界を守った堅牢な変更を支援する。
---

# coding-standards スキルガイド

## 目的

- Rust コードを追加・変更するときに、Microsoft Pragmatic Rust Guidelines と本リポジトリの方針を一貫して適用する。
- レビュー負担を減らし、ヘキサゴナルアーキテクチャを崩さない堅牢な変更を下支えする。

## 適用タイミング

- `src/` や `tests/` 配下の Rust コードを作成・編集・削除するとき。
- CLI/Presenter 層も含め、ビルドに影響する設定を触るとき。

## 主要ルール

1. **設計指針**: ロジックは `domain`/`use_case`、外部適合は `infrastructure`/`presenter` に限定する。
2. **エラー処理**: `Result` とカスタムエラー型を優先。`unwrap`/`expect` はテストや初期化コードのみで使用可。
3. **API 設計**: Public API には意味のある型名、`&[T]`/`&str` のような参照を使う。破壊的変更はインタフェース層で吸収。
4. **性能と相互運用性**: 不要なアロケーションを避け、`Iterator`/`Cow` など標準トレイトを活用。FFI 境界では `unsafe` を局所化。
5. **ドキュメント**: 意図が読み取りづらい変換やアルゴリズムには短いコメントを残す。README/マニュアルとの齟齬を作らない。

## 作業手順

1. 変更前に `~/rust-guidelines.txt` を参照し、該当セクション(エラー処理・API 設計・性能)を確認。
2. 実装ではレイヤリングと依存方向を常に意識し、必要ならユースケース→インフラの順で改修する。
3. フォーマットと静的解析をローカルで実行:
```bash
cargo fmt
cargo clippy --all-targets --all-features
cargo test
```
追加でセキュリティ確認が必要な場合 `cargo audit` を走らせる。
4. テストや CLI 出力の差異は `
``path``
` 表記と再現コマンドをセットで共有する。

## チェックリスト

- [ ] エラー経路は Result/thiserror などで明示されているか。
- [ ] 新規 API の命名・可視性はドメインモデルと整合しているか。
- [ ] 不要な `clone`・`String` 化を避け、参照を渡しているか。
- [ ] `cargo fmt`, `clippy`, `cargo test` を成功させたか (ログを確認したか)。

## 参考資料

- Microsoft Pragmatic Rust Guidelines: `~/rust-guidelines.txt`
- リポジトリ共通方針: `.github/copilot-instructions.md`
53 changes: 53 additions & 0 deletions .github/skills/testing-practices/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: testing-practices
description: Rust 変更を安全に統合するための標準テストフローと品質ゲートを定義する。
---

# testing-practices スキルガイド

## 目的

- Rust コードやビルド設定を触る際に、必要な検証手順を明示して品質を一定に保つ。
- テスト結果の共有方法を統一し、レビューの手戻りを減らす。

## 適用タイミング

- `src/` や `tests/` 配下のコードを変更・追加・削除するとき。
- Cargo 設定や CI スクリプトを更新してビルド/テスト結果に影響が出るとき。

## 推奨コマンド

```bash
cargo fmt
cargo clippy --all-targets --all-features
cargo test
cargo nextest run --all --all-features # 長時間テストやCI検証が必要な場合
cargo audit # 依存パッケージの脆弱性チェック
```

## 実行手順

1. 変更内容に応じて必要なテストデータや API 資格情報を準備する。
2. `cargo fmt` でフォーマッタ差分を解消し、`cargo clippy --all-targets --all-features` で警告が出ないことを確認。
3. `cargo test` でユニット/統合テストを実行し、失敗した場合は該当ターゲットを `-- --nocapture` などで再実行して切り分ける。
4. 長時間処理やCI互換が求められる変更は `cargo nextest run --all --all-features` を追加実行する。
5. 依存を更新した場合やセキュリティリスクを懸念する場合は `cargo audit` を実施し、出力を記録する。
6. レビュー提出時は成功したコマンドとログ要約を共有し、差分が生じたファイルパスはバッククオートで提示する。

## チェックリスト

- [ ] フォーマッタと Clippy を警告ゼロで通過したか。
- [ ] 追加・変更したロジックに対してユニットテスト/統合テストを更新したか。
- [ ] `cargo test`/`cargo nextest run` の結果を確認し、失敗ケースを再現できるログを添付したか。
- [ ] 依存更新時に `cargo audit` を実行し、CVE が残っていないか。

## 失敗時の切り分けメモ

- Clippy が `allow` 無しで回避できない場合は `coding-standards` に立ち返り設計を再検討する。
- 外部 API を叩くテストは `-- --ignored` 等で分離し、副作用がある場合はモックや固定データを使う。
- 長時間テストが CI 限定の場合、ローカルでは対象モジュールに絞り `cargo test path::to::module` を使って最小範囲で再現する。

## 参考資料

- 共通方針: `.github/copilot-instructions.md`
- 設計ルール: `.github/skills/coding-standards/SKILL.md`
Loading
Loading