|
1 | | -# cursorrules 「v5」 |
| 1 | +# cursorrules "v5" |
2 | 2 |
|
3 | | -[English](README.en.md) | 日本語 |
| 3 | +🇬🇧 **English** | 🇯🇵 **日本語** |
4 | 4 |
|
5 | | -このリポジトリは、Cursor用のカスタムインストラクションを管理するためのものです。 |
| 5 | +--- |
6 | 6 |
|
7 | | -## 前提 |
| 7 | +## 🌏 Select Your Language / 言語を選択 |
8 | 8 |
|
9 | | -- この`v5`は、Cursor Agent に最適化されたカスタムインストラクションです |
10 | | -- Cursor Agent が自走(人の介入を受けずに自律処理)ができる前提として、Auto-Run の設定が適切に行われている必要があります。 |
11 | | -- 最新の更新内容については[更新履歴](CHANGELOG.md)を参照してください。 |
| 9 | +This repository provides custom instructions and custom commands optimized for Cursor. |
| 10 | +このリポジトリは、Cursor 用に最適化されたカスタムインストラクションやカスタムコマンドを提供します。 |
12 | 11 |
|
13 | | -## 概要 |
| 12 | +### 📂 Language-specific Documentation |
14 | 13 |
|
15 | | -- Cursor のエージェント機能がリリースされてから、様々なパターンの処理を通して感じたのが「分析力の不足」でした。そのため、モデル(当時のClaude 3.5 Sonnet)が本来持っている分析能力を引き出せるように工夫し始めたのが、私のカスタムインストラクション作成の始まりです。 |
16 | | -- 当初のテーマは、分析能力向上と自走力を高めることがでしたが、その後、モジュールやリソースの重複生成、意図せぬ、AIによるデザインの変更、エラー処理の無限ループなどの防止にも取り組み、モデルの刷新と性能向上と相まって、それなりの成果を残せたように思います。 |
17 | | -- このバージョンアップグレードのフォーカスは GPT-5.1 最適化です: |
18 | | - 1. チェックリスト式の実装計画を立ててから着手。実行後はチェックリストごとに完了を確認することで、より計画性の高いタスク遂行が可能になっています。 |
19 | | - 1. タスクを軽量・標準・重要の3段階に分類し、軽量タスクでは1〜2文の簡潔な報告にとどめ、重いタスクほど手順と検証を厚くするようになっています。 |
20 | | - 1. 並行処理できるタスクは並行処理を行うことで、処理速度が向上します。 |
21 | | -- さらに、`read_file` や `apply_patch`、`run_terminal_cmd` などのツール利用ポリシーを明文化し、常に安全な手順・権限でタスクを進めるワークフローを整備しています。 |
22 | | -- `v5` は、初期にAnthropic Prompt Generatorで作成、それ以降、その時期の最新モデルによる評価、実践による改善を繰り返してきました。カスタマイズの際も、お使いになるAIによる評価を行うことを推奨します。 |
23 | | -- 詳細な更新内容(タスク分類、エラー処理の段階化、ツール利用ポリシーなど)については[CHANGELOG.md](CHANGELOG.md)を参照してください。 |
| 14 | +- 🇯🇵 **日本語版**: [ja/README.md](ja/README.md) |
| 15 | +- 🇬🇧 **English**: [en/README.md](en/README.md) |
24 | 16 |
|
25 | | -- また、本リポジトリ自体がベストプラクティス例として、コミットメッセージ/PRメッセージのルールファイルおよびコミット・プッシュ・PR作成のワークフローコマンドのサンプルを含んでいます。 |
| 17 | +--- |
26 | 18 |
|
27 | | -## 使用方法 |
| 19 | +## ⚡ Quick Start |
28 | 20 |
|
29 | | -1. `.cursor/rules` がまだ存在しない場合は、フォルダを作成してください。 |
30 | | -2. パスが存在する場合は、そこに `v5.en.mdc`(英語)または `v5.mdc`(日本語)を保存してください。 |
31 | | -3. テスト方針ルールを有効にしたい場合は、同じフォルダに `test-strategy.mdc`(日本語)または `test-strategy.en.mdc`(英語)を保存してください。 |
32 | | -4. コミットメッセージ規約を有効にしたい場合は、同じフォルダに `commit-message-format.mdc`(日本語)または `commit-message-format.en.mdc`(英語)を保存してください。 |
33 | | -5. PR メッセージ規約を有効にしたい場合は、同じフォルダに `pr-message-format.mdc`(日本語)または `pr-message-format.en.mdc`(英語)を保存してください。 |
34 | | -- これらのテスト方針ルールの適用条件はデフォルトで「always」となっているため、所定のパスに存在していれば、それ以降のチャットで自動的に参照されます。 |
35 | | -- 日本語版・英語版の両方で `alwaysApply: true` が設定されているため、利用したい言語やテストルールをデフォルトで有効にするかどうかに応じて、この設定を調整してください。 |
36 | | -- これらを有効にすると、テストコードの実装・修正タスクでは、本リポジトリで定義した等価分割・境界値分析やカバレッジ要件などのテスト方針ルールが自動的に適用されます。 |
| 21 | +### For Japanese Users (日本語ユーザー向け) |
37 | 22 |
|
38 | | -ルールファイル(`.cursor/rules/*.mdc`)とワークフローコマンド(`.cursor/commands/*.md`)の役割分担と使い方については、[doc/rules-and-workflows.md](doc/rules-and-workflows.md) を参照してください。 |
| 23 | +```bash |
| 24 | +# リポジトリをクローン |
| 25 | +git clone https://github.com/kinopeee/cursorrules.git |
39 | 26 |
|
40 | | -### ガードレール関連ファイル |
| 27 | +# 日本語版の設定をプロジェクトにコピー |
| 28 | +cp -r cursorrules/ja/.cursor ~/your-project/ |
| 29 | +``` |
41 | 30 |
|
42 | | -- `commit-message-format.mdc` / `commit-message-format.en.mdc` |
43 | | - - **役割**: コミットメッセージのフォーマット(Prefix、サマリ、箇条書き本文など)と禁止事項を定義するファイルです。 |
44 | | - - **特徴**: Conventional Commits をベースにしつつ、`language` による言語指定や差分ベースのメッセージ生成といった、このリポジトリ向けのガイドラインを含みます。 |
| 31 | +詳細は [ja/README.md](ja/README.md) をご覧ください。 |
45 | 32 |
|
46 | | -- `pr-message-format.mdc` / `pr-message-format.en.mdc` |
47 | | - - **役割**: PR タイトルおよび本文のフォーマット(Prefix 付きタイトル、構造化された「概要」「変更内容」「テスト内容」など)と禁止事項を定義するファイルです。 |
48 | | - - **特徴**: コミットメッセージ規約と整合する形で PR メッセージを構造化し、レビューや変更意図の把握をしやすくするためのガイドラインを提供します。 |
| 33 | +### For English Users |
49 | 34 |
|
50 | | -- `test-strategy.mdc` / `test-strategy.en.mdc` |
51 | | - - **役割**: テストコードの実装・修正タスク向けに、等価分割・境界値分析やカバレッジ要件などのテスト方針ルールを定義するファイルです。 |
52 | | - - **特徴**: 本番コードに意味のある変更が入る場合は対応する自動テストの追加・更新を求めるなど、品質面のガードレールとして機能します。 |
| 35 | +```bash |
| 36 | +# Clone the repository |
| 37 | +git clone https://github.com/kinopeee/cursorrules.git |
53 | 38 |
|
| 39 | +# Copy English configuration to your project |
| 40 | +cp -r cursorrules/en/.cursor ~/your-project/ |
| 41 | +``` |
54 | 42 |
|
55 | | -## 翻訳ガイド |
| 43 | +See [en/README.md](en/README.md) for details. |
56 | 44 |
|
57 | | -カスタムインストラクションを他言語へ翻訳する際の推奨プロンプトについては、[TRANSLATION_GUIDE.md](TRANSLATION_GUIDE.md) を参照してください。 |
| 45 | +--- |
58 | 46 |
|
59 | | -## 注意事項 |
| 47 | +## 📋 What's Included / 含まれるもの |
60 | 48 |
|
61 | | -- User Rules、Memories に v5 と矛盾する指示が存在すると、モデルが混乱して、効果が減少します。それぞれの内容を十分にご確認ください。 |
| 49 | +All rule files and workflow commands are available in both Japanese and English. |
| 50 | +すべてのルールファイルとワークフローコマンドに日本語版と英語版があります。 |
62 | 51 |
|
63 | | -## ライセンス |
| 52 | +### ✅ Rule Files (`.cursor/rules/*.mdc`) |
64 | 53 |
|
65 | | -MITライセンスの下で公開されています。詳細については[LICENSE](LICENSE)ファイルを参照してください。 |
| 54 | +- **v5.mdc** – Core coding support rules / コーディング支援ルール |
| 55 | +- **commit-message-format.mdc** – Commit message conventions / コミットメッセージ規約 |
| 56 | +- **pr-message-format.mdc** – PR message conventions / PRメッセージ規約 |
| 57 | +- **test-strategy.mdc** – Test strategy rules / テスト戦略ルール |
| 58 | +- **prompt-injection-guard.mdc** – Injection defense / インジェクション防御 |
66 | 59 |
|
67 | | -## サポート |
| 60 | +### ⚙️ Workflow Commands (`.cursor/commands/*.md`) |
68 | 61 |
|
69 | | -- このリポジトリのサポートはありませんが、フィードバックは歓迎いたします。また、Cursor関連情報をX(Twitter)で発信しているので、ご興味あればご覧ください。 |
70 | | -[X(Twitter)](https://x.com/kinopee_ai) |
| 62 | +- **commit-only.md** – Commit only / コミットのみ |
| 63 | +- **commit-push.md** – Commit & push / コミット&プッシュ |
| 64 | +- **commit-push-pr.md** – Commit, push & PR / コミット&プッシュ&PR |
| 65 | + |
| 66 | +> **📍 File Locations / ファイル配置** |
| 67 | +> |
| 68 | +> - **Repository**: `./ja/.cursor/` (日本語) / `./en/.cursor/` (English) |
| 69 | +> - **Your Project**: Copy to `.cursor/` in your project root |
| 70 | +> |
| 71 | +> For details, see [ja/README.md](ja/README.md) or [en/README.md](en/README.md). |
| 72 | +
|
| 73 | +--- |
| 74 | + |
| 75 | +## 🎯 Key Features / 主な特徴 |
| 76 | + |
| 77 | +### 🇯🇵 日本語 |
| 78 | + |
| 79 | +- **GPT-5.1 & Opus 4.5 最適化**: 適応的推論を活かした効率的なタスク実行 |
| 80 | +- **3段階タスク分類**: 軽量・標準・重要タスクに応じた最適なプロセス |
| 81 | +- **並列実行**: 独立したタスクを並列処理して処理速度を向上 |
| 82 | +- **安全なツール利用**: read_file/apply_patch/run_terminal_cmd の明確なポリシー |
| 83 | +- **包括的なガードレール**: コミット規約、PR規約、テスト戦略、セキュリティ防御 |
| 84 | + |
| 85 | +### 🇬🇧 English |
| 86 | + |
| 87 | +- **GPT-5.1 & Opus 4.5 Optimized**: Efficient task execution leveraging adaptive reasoning |
| 88 | +- **3-Tier Task Classification**: Optimal processes for lightweight/standard/critical tasks |
| 89 | +- **Parallel Execution**: Improved throughput by parallelizing independent tasks |
| 90 | +- **Safe Tool Usage**: Clear policies for read_file/apply_patch/run_terminal_cmd |
| 91 | +- **Comprehensive Guardrails**: Commit conventions, PR conventions, test strategy, security defense |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +## 📖 Documentation / ドキュメント |
| 96 | + |
| 97 | +### 🇯🇵 日本語 |
| 98 | + |
| 99 | +- [使い方ガイド](ja/README.md) |
| 100 | +- [変更履歴](ja/CHANGELOG.md) |
| 101 | +- [ルールとワークフロー](ja/doc/rules-and-workflows.md) |
| 102 | +- [プロンプトインジェクション防御](ja/doc/prompt-injection-guard.md) |
| 103 | + |
| 104 | +### 🇬🇧 English |
| 105 | + |
| 106 | +- [Usage Guide](en/README.md) |
| 107 | +- [Changelog](en/CHANGELOG.md) |
| 108 | +- [Rules and Workflows](en/doc/rules-and-workflows.md) |
| 109 | +- [Prompt Injection Guard](en/doc/prompt-injection-guard.md) |
| 110 | + |
| 111 | +--- |
| 112 | + |
| 113 | +## 📄 License / ライセンス |
| 114 | + |
| 115 | +MIT License - See [LICENSE](LICENSE) for details. |
| 116 | +MITライセンス - 詳細は [LICENSE](LICENSE) を参照してください。 |
| 117 | + |
| 118 | +--- |
| 119 | + |
| 120 | +## 💬 Support / サポート |
| 121 | + |
| 122 | +### 🇯🇵 日本語 |
| 123 | + |
| 124 | +このリポジトリに公式サポートはありませんが、フィードバックは歓迎します。 |
| 125 | +Cursor関連情報を X (Twitter) で発信しています: [@kinopee_ai](https://x.com/kinopee_ai) |
| 126 | + |
| 127 | +### 🇬🇧 English |
| 128 | + |
| 129 | +There is no official support for this repository, but feedback is welcome. |
| 130 | +Follow on X (Twitter) for Cursor-related updates: [@kinopee_ai](https://x.com/kinopee_ai) |
| 131 | + |
| 132 | +--- |
| 133 | + |
| 134 | +## Made with ❤️ for Cursor IDE users worldwide |
0 commit comments