CONTRIBUTING.md

🤝 貢献ガイドライン

📝 はじめに

このプロジェクトへの貢献に興味をお持ちいただき、ありがとうございます！このドキュメントでは、ポケモン図鑑プロジェクトに貢献するための手順を説明します。

🔄 開発フロー

1. このリポジトリをフォークします
2. 機能ブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m '✨ feat: 素晴らしい機能を追加'）
4. ブランチをプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します

📋 コーディング規約

• 変数名、関数名、クラス名、ファイル名などのコード要素は英語で記述してください
• コメント、ドキュメント、コミットメッセージは日本語で記述してください
• インデントには2スペースを使用してください
• 関数やクラスには適切なJSDocコメントを付けてください
• ESLintの規約に従ってください

💻 コミットメッセージ規約

以下の形式に従ってコミットメッセージを書いてください：

<絵文字> <タイプ> #<Issue番号>: <タイトル>
<本文>
<フッター>

タイプ

• 🎉 feat: 新機能
• 🐛 fix: バグ修正
• 📚 docs: ドキュメントの変更
• 🎨 style: コードスタイルの変更（動作に影響しない）
• ♻️ refactor: リファクタリング
• ⚡ perf: パフォーマンス改善
• 🧪 test: テストの追加・修正
• 🔧 chore: ビルドプロセスやツールの変更

🚀 開発環境のセットアップ

1. リポジトリをクローンします：

   git clone https://github.com/your-username/pokemon-pokedex.git
   cd pokemon-pokedex
   

2. 開発サーバーを起動します：

   # Python 3を使用する場合
   python -m http.server
   
   # または Node.jsの場合は live-server などを使用
   npx live-server
   

3. ブラウザで http://localhost:8000 にアクセスします

🧪 テスト

新機能やバグ修正を提出する前に、以下のテストを行ってください：

• 異なるブラウザ（Chrome、Firefox、Safari、Edge）での表示確認
• モバイルデバイスでのレスポンシブ表示確認
• 検索機能の動作確認
• ポケモン選択とデータ表示の確認

🔍 イシューの報告

バグを見つけた場合は、以下の情報を含むイシューを作成してください：

• バグの簡潔な説明
• 再現手順
• 期待される動作
• スクリーンショット（可能であれば）
• 環境情報（ブラウザ、OS）

🎯 機能リクエスト

新機能のアイデアがある場合は、以下の情報を含むイシューを作成してください：

• 機能の簡潔な説明
• その機能がどのように役立つか
• 実装のアイデア（オプション）

📄 ライセンス

このプロジェクトへの貢献は、プロジェクトのライセンスに基づいて行われます。詳細は LICENSE ファイルを参照してください。