設定
ルール
ルールファイルで Verdent の動作を制御する
ルールファイルは、Verdent がコーディングセッション中にどう動作するかを定義する Markdown ドキュメントです。AI エージェントの動作、出力の整形、プロジェクト標準への準拠を導きます。
このページで学べること
- ユーザールールとプロジェクトルールの理解
- 各ルールタイプの使い分け
- 効果的なルールの書き方
ルールの種類
| ルールタイプ | ファイル | スコープ | 目的 |
|---|---|---|---|
| ユーザールール | VERDENT.md | グローバル（すべてのプロジェクト） | 個人のコーディング設定 |
| プロジェクトルール | AGENTS.md | 現在のプロジェクト | チームの規約、プロジェクト標準 |
場所:
- ユーザールール:
~/.verdent/VERDENT.md - プロジェクトルール:
<project>/AGENTS.md
ユーザールール（VERDENT.md）
ユーザールールを使うと、すべてのプロジェクトにわたって Verdent の動作をカスタマイズできます。
アクセス: Settings → User Rules
自動保存: 変更は 500ms 後に自動保存されます
- コーディングスタイルの設定: インデント、命名規則
- フレームワークの規約: React、Vue、言語の標準
- 応答の整形: 詳細度、説明のスタイル
- 個人のワークフロー設定: トーン、コミュニケーションのスタイル
# User Rules
## Code Style
- Always use TypeScript with strict mode
- Prefer functional components over class components
- Use Tailwind CSS for styling
- Follow the project's existing naming conventions
## Communication
- Provide brief explanations
- Show code first, explain after
- Write concise commit messages in conventional formatプロジェクトルール（AGENTS.md）
プロジェクトルールは、現在のプロジェクトに固有の標準を定義します。バージョン管理にコミットすれば、チーム全体で共有できます。
アクセス: Project Settings パネル
場所: プロジェクトルート（<project>/AGENTS.md）
- チームの規約: 共有のコーディング標準
- アーキテクチャ: デザインパターン、状態管理
- テスト: カバレッジ要件、フレームワーク
- ワークフロー: ビルドコマンド、PR ガイドライン
# AGENTS.md
## Dev Environment
- Run `pnpm install` to set up
- Use `pnpm dev` for local development
## Testing
- Run `pnpm test` before committing
- Minimum 80% coverage required
## PR Guidelines
- Use conventional commit format
- Include tests for new featuresAGENTS.md をバージョン管理でチームと共有し、すべてのメンバー間で一貫した AI の動作を確保しましょう。
効果的なルールの書き方
具体的に書く:
# Good
- Use async/await for asynchronous operations
- Include JSDoc comments for exported functions
# Avoid
- Try to use modern JavaScript features
- Add comments when necessaryベストプラクティス:
- 明確で指示的な表現を使う（「常に…」「決して…しない」「…を優先する」）
- 関連するルールをセクション見出しの下にまとめる
- ルールは簡潔に保つ（1 つの箇条書きに 1 つの概念）
- プロジェクトの進化に合わせてルールを見直し、更新する
よくある質問
ルールファイルはどう作成しますか？
個人の設定は Settings → User Rules に移動して VERDENT.md を編集します。プロジェクト固有のルールは、プロジェクトルートに AGENTS.md を作成します。箇条書きを使ったプレーンな Markdown で記述します。
ルールの変更はいつ反映されますか？
ルールの変更は新しい会話で即座に適用され、現在の会話の応答にも影響します。
ルールを一時的に上書きできますか？
プロンプトに具体的な指示を記載することで、単一のリクエストに対してルールを上書きできます。