// Cursor AI用の.cursorrulesファイルガイドライン
// 基本的な説明
.cursorrulesファイルは、Cursor AIの動作をプロジェクトごとにカスタマイズするための設定ファイルです。このファイルをリポジトリのルートに配置することで、Cursor AIがプロジェクトの文脈をより良く理解し、適切な提案やコード生成を行うことができます。
// README.mdの構造
README.mdファイルは以下の構造を維持してください:
1. タイトルとAwesomeバッジ: プロジェクトのタイトルとバッジを表示します。
2. ロゴ: プロジェクトのロゴを表示します。
3. 簡単な説明: プロジェクトの概要を簡潔に説明します。
4. 「なぜ.cursorrules?」セクション: .cursorrulesファイルの重要性を説明します。
5. 目次: 各セクションへのリンクを含む目次を提供します。
6. ルールセクション: 以下のカテゴリに分けてルールを記載します。
- フロントエンドフレームワークとライブラリ
- バックエンドとフルスタック
- モバイル開発
- CSSとスタイリング
- 状態管理
- データベースとAPI
- テスト
- ビルドツールと開発
- 言語固有
- その他
7. 使用方法セクション: .cursorrulesファイルの使用方法を説明します。
貢献方法セクション: プロジェクトへの貢献方法を説明します。
9. ライセンスセクション: プロジェクトのライセンス情報を提供します。
// ルールの組織化
.cursorrulesファイルは、rulesディレクトリ内の以下の主要カテゴリに整理します:
- フロントエンドフレームワークとライブラリ
- バックエンドとフルスタック
- モバイル開発
- CSSとスタイリング
- 状態管理
- データベースとAPI
- テスト
- ビルドツールと開発
- 言語固有
- その他
各.cursorrulesファイルはrulesフォルダに直接配置します。
フォルダ名はファイルのカテゴリと内容を説明するものにします。
各フォルダのREADMEを参照して命名規則と説明を確認します。
// 命名とフォーマット
.cursorrulesファイルとそのフォルダには、`technology`-`focus`-`cursorrules`-`prompt`-`file` のパターンに従った説明的な名前を付けます。
README.mdファイル内の各カテゴリはアルファベット順に整理します。
リスト項目のフォーマットは一貫性を保ちます。
// コンテンツガイドライン
.cursorrulesファイルを作成または編集する際は、プロジェクト固有の指示とベストプラクティスに焦点を当てます。
複雑なルールには説明コメントを付けてコンテキストを提供します。
すべてのドキュメントと.cursorrulesファイルには明確で簡潔な言語を使用します。
プロジェクトの構築、スタイルガイドライン、または一般的に使用されるメソッドに関するコンテキストを提供します。
// メンテナンスと更新
新しい.cursorrulesファイルを追加する際は、README.mdファイルを更新し、正しいカテゴリに配置します。
README.mdファイル内のすべてのリンクが相対的で正しいことを確認します。
README.mdを更新する際は、目次が正確であることを確認します。
新しいカテゴリを追加する際は、README.mdの「目次」と「ルール」セクションの両方を更新します。
リポジトリが成長するにつれて、カテゴリの整理を定期的に見直し、更新します。
// ベストプラクティス
リポジトリ全体で大文字小文字と句読点の一貫性を保ちます。
Cursor AIを参照する際は、常に正しい大文字小文字とスペースを使用します。
例や説明を追加する際は、Cursor AIユーザーの実践的なユースケースに焦点を当てます。
.cursorrulesファイルが複数のカテゴリに適合する場合は、最も関連性の高いカテゴリに配置し、必要に応じて他のカテゴリで参照します。
「その他」カテゴリは、主要カテゴリにうまく収まらない.cursorrulesファイル用に保持します。
// ドキュメントの読み込み設定
README.mdの参考文献から以下の順序でドキュメントを読み込みます:
- 「参考文献」セクションに従う
- 記載順にURLを読み込む
- これらのドキュメントをAIアシスタンスの参考として使用
// 例:
```markdown:README.md
## 参考文献
- [Document](url)
```
// 参考文献の優先順位
ドキュメントの優先順位:
1. プロジェクト固有のドキュメント(README.mdから)
2. フレームワークとライブラリのドキュメント
3. 一般的な仕様と標準
// ドキュメントの使用方法
アシスタンス提供時:
- 読み込まれたドキュメントを正確な情報源として参照
- 参照ドキュメントから最新の仕様に従う
- プロジェクト固有のガイドラインを優先
// 追加の洞察
.cursorrulesファイルはリポジトリ固有の「AIのためのルール」です。
.cursorrulesファイルはリポジトリのルートに配置します。
.cursorrulesファイルの内容は、Cursorのグローバル「AIのためのルール」設定に追加されます。
一般的なコーディングプラクティスではなく、リポジトリレベルのコンテキストとガイドラインを提供することに焦点を当てます。
.cursorrulesには、プロジェクト構造、アーキテクチャの決定事項、一般的に使用されるライブラリやメソッドに関する情報を含めることができます。
プロジェクト固有のファイルタイプやコーディングパターンの扱い方に関するルールを含めることを検討します。
ルールは、Cursor AIのコード生成とコード理解の両方の側面をカバーできます。
このガイドラインに従うことで、Cursor AIがプロジェクトの文脈をより良く理解し、より適切な提案やコード生成を行うことができるようになります。
css
dockerfile
makefile
ruby
shell
vim script
First Time Repository
Shell
Languages:
CSS: 20.8KB
Dockerfile: 3.5KB
Makefile: 1.3KB
Ruby: 7.2KB
Shell: 81.5KB
Vim Script: 26.7KB
Created: 11/27/2024
Updated: 1/21/2025