このプロジェクトへのコントリビュートに興味を持ってくれてありがとう!このガイドは、効果的にコントリビュートする方法を理解する助けとなる。

本プロジェクトについて

Claude How To は Claude Code への視覚的でサンプル駆動のガイドである。提供する内容:

コントリビューションの種類

1. 新しい例やテンプレート

既存機能(スラッシュコマンド、スキル、フックなど)の例を追加する:

2. ドキュメントの改善

3. 機能ガイド

新しい Claude Code 機能のガイドを作成する:

4. バグ報告

遭遇した問題を報告する:

5. フィードバックと提案

ガイドの改善を助ける:

はじめに

1. フォークとクローン

git clone YOUR_REPO
cd claude-howto

2. ブランチを作成

わかりやすいブランチ名を使う:

git checkout -b add/feature-name
git checkout -b fix/issue-description
git checkout -b docs/improvement-area

3. 環境のセットアップ

pre-commit フックは、各コミット前に CI と同じチェックをローカルで実行する。すべての 4 チェックが通過しなければ PR は受理されない。

必須の依存関係:

# Python ツール(このプロジェクトのパッケージマネージャは uv)
pip install uv
uv venv
source .venv/bin/activate
uv pip install -r scripts/requirements-dev.txt

# Markdown リンタ(Node.js)
npm install -g markdownlint-cli

# Mermaid 図バリデータ(Node.js)
npm install -g @mermaid-js/mermaid-cli

# pre-commit をインストールしてフックを有効化
uv pip install pre-commit
pre-commit install

セットアップの確認:

pre-commit run --all-files

各コミットで実行されるフックは以下のとおり:

フック 検査内容
markdown-lint Markdown のフォーマットと構造
cross-references 相対リンク、アンカー、コードフェンス
mermaid-syntax すべての ```mermaid ブロックが正しくパースされるか
link-check 外部 URL が到達可能か
build-epub EPUB がエラーなく生成されるか(.md 変更時)

ディレクトリ構造

├── 01-slash-commands/      # ユーザーが起動するショートカット
├── 02-memory/              # 永続コンテキストの例
├── 03-skills/              # 再利用可能な能力
├── 04-subagents/           # 専門 AI アシスタント
├── 05-mcp/                 # Model Context Protocol の例
├── 06-hooks/               # イベント駆動の自動化
├── 07-plugins/             # バンドル機能
├── 08-checkpoints/         # セッションのスナップショット
├── 09-advanced-features/   # プランニング、シンキング、バックグラウンド
├── 10-cli/                 # CLI リファレンス
├── scripts/                # ビルドおよびユーティリティスクリプト
└── README.md               # メインガイド

サンプルをコントリビュートする方法

スラッシュコマンドの追加

  1. 01-slash-commands/.md ファイルを作成
  2. 以下を含める:
    • 何をするかの明確な説明
    • ユースケース
    • インストール手順
    • 使用例
    • カスタマイズのヒント
  3. 01-slash-commands/README.md を更新

スキルの追加

  1. 03-skills/ にディレクトリを作成
  2. 以下を含める:
    • SKILL.md — メインドキュメント
    • scripts/ — 必要に応じてヘルパースクリプト
    • templates/ — プロンプトテンプレート
    • README に使用例
  3. 03-skills/README.md を更新

サブエージェントの追加

  1. 04-subagents/.md ファイルを作成
  2. 以下を含める:
    • エージェントの目的と能力
    • システムプロンプトの構造
    • ユースケースの例
    • 統合例
  3. 04-subagents/README.md を更新

MCP 設定の追加

  1. 05-mcp/.json ファイルを作成
  2. 以下を含める:
    • 設定の説明
    • 必要な環境変数
    • セットアップ手順
    • 使用例
  3. 05-mcp/README.md を更新

フックの追加

  1. 06-hooks/.sh ファイルを作成
  2. 以下を含める:
    • シェバンと説明
    • ロジックを説明する明確なコメント
    • エラー処理
    • セキュリティ考慮事項
  3. 06-hooks/README.md を更新

執筆ガイドライン

Markdown スタイル

コード例

ドキュメント

JSON/YAML

コミットガイドライン

Conventional Commits 形式に従う:

type(scope): description

[optional body]

種別:

例:

feat(slash-commands): Add API documentation generator
docs(memory): Improve personal preferences example
fix(README): Correct table of contents link
docs(skills): Add comprehensive code review skill

提出前

チェックリスト

ローカルテスト

# すべての pre-commit チェックを実行(CI と同じチェック)
pre-commit run --all-files

# 変更内容をレビュー
git diff

プルリクエストのプロセス

  1. 明確な説明とともに PR を作成:

    • 何を追加/修正するか?
    • なぜ必要か?
    • 関連する Issue(あれば)
  2. 関連する詳細を含める:

    • 新機能の場合:ユースケースを含める
    • ドキュメントの場合:改善点を説明する
    • サンプルの場合:ビフォア/アフターを示す
  3. Issue にリンクする:

    • Closes #123 を使うと関連 Issue を自動クローズ
  4. レビューを辛抱強く待つ:

    • メンテナーが改善を提案することがある
    • フィードバックに基づいて反復する
    • 最終判断はメンテナーが行う

コードレビュープロセス

レビュアーは以下を確認する:

Issue の報告

バグ報告

以下を含める:

機能リクエスト

以下を含める:

ドキュメントの問題

以下を含める:

プロジェクトポリシー

機微な情報

コード品質

知的財産

ヘルプを得る

謝辞

コントリビュータは以下で認識される:

セキュリティ

例やドキュメントをコントリビュートする際は、安全なコーディング慣行に従ってほしい:

セキュリティ問題については、脆弱性報告プロセスについて SECURITY.md を参照。

行動規範

私たちは温かく包摂的なコミュニティを提供することにコミットしている。コミュニティ基準の詳細は CODE_OF_CONDUCT.md を読んでほしい。

要点:

すべてのコントリビュータはこの規範を遵守し、互いに親切と敬意を持って接することが求められる。

ライセンス

本プロジェクトへのコントリビューションは MIT License の下でライセンスされることに同意するものとする。詳細は LICENSE を参照。

質問は?

コントリビュートしてくれてありがとう!🙏


Last Updated: April 9, 2026