はじめに
JetBrains AI の Junie を使っている開発者のみなさん、guidelines.mdというファイルを作成していますか？
チーム開発を進めるうえで、プロジェクト固有のルールやコーディング標準を毎回共有したり、説明したりするのは手間です。
AI コーディングエージェント「Junie」では、こうした課題を解決するために guidelines.md ファイルを活用できます。
このファイルを .junie 配下に設置することで、Junie をチーム向けにパーソナライズし、より効果的に活用できます。
guidelines.md とは？
.junie/guidelines.md は、Junie にプロジェクト固有のルールやベストプラクティスを伝えるための「ガイドライン定義ファイル」です。
このファイルに記載された内容は、Junie のコンテキストに取り込まれ、以降の操作や提案に自動的に反映されます。
プロジェクトにガイドラインを追加する
guidelines.mdファイルには任意の形式で指示を記載できます。
例:
-
テストは必ず特定のフォルダに追加すること、または特定のフレームワークを使用することを指定する。
-
リポジトリ内に既存のガイドラインがある場合、その正しいファイルパスを Junie に伝えると、それを読み取り適用します。
-
Junie の挙動に最適でない部分があれば、ガイドラインファイルにヒントや補足を追加します。これらの指示は Junie のコンテキストに取り込まれ、より良い判断を行い、プロジェクト内でより効果的に機能するようになります。
Junie にguidelines.mdを作成依頼
プロジェクトにまだguidelines.mdがない場合は、以下のように Junie に頼んでみましょう：
「プロジェクトの構造と技術スタックを分析し、新しい開発者の支援となるように、簡潔で整理された情報を含む.junie/guidelines.md ファイルを作成してください。構造の整理方法、テストの実行方法、スクリプトの実行方法、ベストプラクティスの遵守についてのガイダンスを含めてください。内容は簡潔、明確で、実践的にしてください。」
このようにプロジェクトの構造やルールを明確化しておくと、Junie はそれを踏まえたうえで回答を生成します。
ベストプラクティス
- 短く明確に書く：冗長な説明よりも、ルールを箇条書きで示す。
- 実践的にする：抽象的な表現ではなく、具体的なファイルパスやコマンドを記載。
-
継続的に更新する：ルール変更時は
guidelines.mdも随時メンテナンス。 - チーム共有：レビューを通じて全員が納得できる基準を作成。
まとめ
本記事ではJunieを活用するためのguidelines.mdについて紹介しました。
プロジェクトごとのルールを明確にし、Junie に反映させることで、開発体験をより統一的かつ効率的に進めることができます。