株式会社エーティ・プランニング
先端技術本部
コンサルティング＆アーキテクトグループ（CAG）
本リポジトリは、先端技術本部が制定した Java コーディング規約（原典: Javaコーディング規約.docx）を単一の参照源として管理し、Pull Request レビューおよび AI によるコードレビューで利用できるよう整備したものです。
Note
公開範囲
社内・社外を問わず、Java でソフトウェアを開発する者向けに公開しています。
Caution
免責
本リポジトリの内容は、先端技術本部が現時点の best effort で提供するものです。
内容の完全性・正確性・最新性、および特定目的への適合性を保証するものではありません。
利用・参照は各自の責任で行い、プロジェクトの要件に応じて判断してください。
規約の変更は docs/CONTRIBUTING.md に従います。
- 規約（Markdown版）: java/CODING_RULES.md
- レビュー判定: java/REVIEW_CHECKLIST.md
- OK/NG例: java/PATTERNS.md, java/NG_PATTERNS.md
- プロンプト: java/AI_PROMPT.md
- 利用ルール: java/AI_RULES.md
- 原典（Word）: docs/original/Javaコーディング規約.docx
- 規約から参照する画像: docs/images/
- 変更履歴（詳細）: docs/CHANGELOG.md（要約は本ファイル末尾の 改定履歴）
- 規約の変更手順: docs/CONTRIBUTING.md
- PRテンプレート: .github/pull_request_template.md
- 再利用可能な品質チェック CI: .github/workflows/reusable-java-quality.yml
- 品質設定一式（Checkstyle / SpotBugs テンプレ / markdownlint）: templates/quality/
- Maven 品質プラグイン設定（完全版）: templates/quality/maven/quality-plugins.xml
- Maven 品質プラグイン（簡易・レガシー）: templates/maven/quality-plugins.xml
java/CODING_RULES.md（具体例は java/PATTERNS.md / java/NG_PATTERNS.md）
.github/pull_request_template.md に従い、java/CODING_RULES.md と java/REVIEW_CHECKLIST.md で確認する
手順の正本: java/AI_PROMPT.md
レビュー対象は本リポジトリではなく、AIエディタで開いている Java アプリケーション の src/main/java（PR の差分は見ない。ルール試験・ベースライン監査用）。
前提として java/AI_RULES.md・java/CODING_RULES.md・java/REVIEW_CHECKLIST.md を読ませること（任意: java/PATTERNS.md / java/NG_PATTERNS.md）。
① レビュー対象の Java プロジェクトを AIエディタで開く
② AIチャットに、次の raw URL（blob ではなく raw.githubusercontent.com）を読ませる
送信例（そのまま送信してよい）:
次の raw URL を読み、AI_PROMPT.md の手順に従い、
現在のワークスペースの src/main/java を一括レビューしてください。
PR・git 差分・src/test は対象外です。
https://raw.githubusercontent.com/atplanning-sentan/docs-coding-guidelines-java/main/java/AI_PROMPT.md
https://raw.githubusercontent.com/atplanning-sentan/docs-coding-guidelines-java/main/java/AI_RULES.md
https://raw.githubusercontent.com/atplanning-sentan/docs-coding-guidelines-java/main/java/CODING_RULES.md
https://raw.githubusercontent.com/atplanning-sentan/docs-coding-guidelines-java/main/java/REVIEW_CHECKLIST.md
③ バージョンを固定する場合は、上記 URL の main をコミット SHA に差し替える
④ 任意ファイル（PATTERNS / NG_PATTERNS）や詳細手順: AI_PROMPT.md 付録「方式A」
① 本リポジトリを clone する
② レビュー対象プロジェクトを AIエディタで開き、必要ならワークスペースに本リポジトリを追加する
③ AIチャットで次を @ 添付する（パスは clone 先に合わせる）
java/AI_PROMPT.mdjava/AI_RULES.mdjava/CODING_RULES.mdjava/REVIEW_CHECKLIST.md- （任意）
java/PATTERNS.md/java/NG_PATTERNS.md
④ 続けて次を送る
AI_PROMPT.md に従い、本ワークスペースの src/main/java を一括レビューしてください。
PR・git 差分・src/test は対象外。【出力】§1〜§5 と REVIEW_CHECKLIST 全項目の表を出してください。
⑤ チームで規約版を揃える場合は tag または commit を checkout する
他リポジトリから .github/workflows/reusable-java-quality.yml を workflow_call で呼び出す。templates/quality/ をコピーし、templates/quality/maven/quality-plugins.xml を pom.xml に取り込む。
.
├── java/ # 規約・チェックリスト・AI用ドキュメント
├── docs/
│ ├── images/ # 規約から参照する図
│ ├── original/ # 原典 docx
│ ├── CHANGELOG.md
│ └── CONTRIBUTING.md # 規約の変更手順
├── .github/
│ ├── pull_request_template.md
│ └── workflows/
└── templates/
├── quality/ # Checkstyle / SpotBugs / markdownlint（推奨）
└── maven/ # 品質プラグイン簡易テンプレ（レガシー）
| 日付 | 内容 |
|---|---|
| 2026-05-15 | 新規制定（原典 docx の Markdown 化、レビュー・AI・CI テンプレート一式）。README・CODING_RULES.md を実構成に合わせて整備 |
| 2026-05-18 | 企業公開向け README 整備（日本語タイトル・正式社名・先端技術本部 CAG 表記・公開範囲/免責の Alert、AI レビュー起動手順、使い方の見出し構成と ① 手順）。CODING_RULES.md の説明文を文単位改行に整理。AI_PROMPT.md に起動テンプレート付録を追加 |
| 2026-05-18 | templates/quality/ 追加（Checkstyle / SpotBugs / markdownlint / Maven 連携） |