Skip to content

kinopeee/clauderule

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

clauderule

ルールでガードレール、コマンドで自動化 ── AIエージェント活用の二本柱

Claude Code向けのルール(CLAUDE.md)とカスタムコマンド(スラッシュコマンド)のテンプレートリポジトリです。

このリポジトリは、Software Design誌「プログラミング×AI の最前線」連載の解説記事で紹介するサンプルです。

目次

ディレクトリ構成

clauderule/
├── CLAUDE.md               # ルール(プロジェクト規約)
├── .claude/
│   └── commands/           # コマンド(スラッシュコマンド)
│       ├── commit.md       # /commit - コミットのみ
│       ├── commit-push.md  # /commit-push - コミット&プッシュ
│       └── commit-push-pr.md # /commit-push-pr - コミット&プッシュ&PR作成
├── .gitignore
└── README.md

ルール(CLAUDE.md)

ルールファイルには「守るべき規約」を定義します:

  • コミットメッセージ規約: フォーマット、Prefix一覧、禁止事項
  • Git操作の制限: 明示的な指示なしに実行してはいけない操作
  • セキュリティポリシー: 機密ファイルのコミット禁止など

本リポジトリでの定義内容

セクション 内容
フォーマット <Prefix>: <サマリ> + 箇条書き本文
Prefix一覧 feat / fix / refactor / docs など
禁止事項 曖昧なサマリ、機密ファイルのコミット
Git操作の制限 明示的指示なしのcommit/push/merge禁止

コマンド(.claude/commands/)

コマンドファイルには「実行手順」のみを記載します:

コマンド 用途
/commit ローカルコミットのみ
/commit-push コミット → プッシュ
/commit-push-pr コミット → プッシュ → PR作成

本リポジトリでの設計

各コマンドは以下の構成で統一:

  1. 差分確認 - git status / git diff で変更内容を把握
  2. 変更内容の分析 - 差分から適切なPrefixを判断
  3. ステージング - git add -A
  4. コミット作成 - 「CLAUDE.md の規約に従って」と参照
  5. 結果確認 - git status / git log

使い方

1. リポジトリをクローン

git clone https://github.com/kinopeee/clauderule.git
cd clauderule

2. 既存プロジェクトに導入

# CLAUDE.md をコピー
cp clauderule/CLAUDE.md your-project/

# コマンドディレクトリをコピー
cp -r clauderule/.claude your-project/

3. プロジェクトに合わせてカスタマイズ

  • CLAUDE.md: プロジェクト固有のルールを追加
  • .claude/commands/: 必要に応じてコマンドを追加・編集

カスタマイズ例

言語を英語に変更

CLAUDE.md の言語設定を変更:

- **言語**: 英語(`language = "en"`

Prefix を追加

プロジェクト固有の Prefix を追加:

| `security` | セキュリティ修正 |
| `deps` | 依存関係の更新 |

コマンドを追加

.claude/commands/review.md など、レビュー用コマンドを追加:

# コードレビュー

現在の差分に対してコードレビューを実施する。

## 観点
- セキュリティ
- パフォーマンス
- 可読性

発展的な使い方

CLAUDE.md の配置場所

CLAUDE.md は複数の場所に配置でき、階層的に適用されます:

レベル 配置場所 用途
システム /Library/Application Support/ClaudeCode/ 企業ポリシー
ユーザー ~/.claude/CLAUDE.md 個人設定
プロジェクト ./CLAUDE.md プロジェクト共通
ローカル ./CLAUDE.local.md 個人用(自動で.gitignore)

インポート機能

ルールを分割管理する場合、インポート機能が使えます:

project/
├── CLAUDE.md                    # メイン
└── .claude/
    ├── git-rules.md            # Gitルール
    └── coding-standards.md     # コーディング規約

CLAUDE.md から参照:

# プロジェクトルール

@.claude/git-rules.md
@.claude/coding-standards.md
  • @path/to/file で相対パス指定
  • 最大5階層まで再帰的にインポート可能

ライセンス

MIT

関連リンク

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors