[Brstcat]の公式GitHub組織へようこそ。私たちのチームの一員になっていただき、ありがとうございます。このリポジトリには、開発プロセスおよびGitHubの使用に関するガイドラインとルールが記載されています。円滑な協力のために、これらのルールを読んで遵守してください。

• 開発ルール
• GitHub使用ルール
• 継続的デプロイ
• 行動規範
• コミュニケーション
• サポート

1. ブランチ戦略:

   • メインブランチ: mainブランチには安定した本番環境用のコードが含まれます。
   • 開発ブランチ: developブランチは、機能の統合およびテストのために使用され、mainにマージされる前に使用します。
   • 開発者ブランチ: 各開発者は自分のブランチを持ち、名前は dev/username とします。すべての作業はこれらのブランチで行います。

2. コミットメッセージ:

   • 明確で簡潔かつ記述的なコミットメッセージを書いてください。
   • 現在形を使用してください（例：「Add feature」ではなく「Added feature」）。
   • 必要に応じて、コミットメッセージに #issue-number を使用して問題を参照してください。

3. プルリクエスト:

   • プルリクエストを作成する前に、ブランチが develop と最新の状態であることを確認してください。
   • 変更内容の詳細な説明を提供してください。
   • 関連するチームメンバーにレビューを依頼してください。
   • すべてのフィードバックとコメントに対処してからマージしてください。

4. テスト:

   • 新機能およびバグ修正のためにユニットテストを書いてください。
   • プルリクエストを提出する前に、すべてのテストが合格していることを確認してください。
   • 継続的インテグレーション（CI）ツールを使用してテストを自動化してください。

1. リポジトリ管理:

   • プロジェクトやモジュールごとにリポジトリを整理してください。
   • 説明的な名前を使用し、明確な構造を維持してください。

2. 課題とラベル:

   • 必要に応じて、GitHubの課題を使用してバグ、強化、およびタスクを追跡してください。
   • 課題に適切なラベルを付けてください（例：bug、enhancement、documentation）。

3. ウィキおよびドキュメント:

   • プロジェクトのドキュメントのために包括的なウィキを維持してください。
   • 変更および新機能について定期的にドキュメントを更新してください。

1. GitHub Actions:

   • デプロイのためにGitHub Actionsを使用します。
   • mainブランチに変更がマージされると、デプロイプロセスが自動的にトリガーされます。

2. デプロイワークフロー:

   • mainにマージする前に、すべてのテストが合格していることを確認してください。
   • デプロイワークフローはプロジェクトをビルドし、テストを実行し、[サーバーのIPまたはURL] にデプロイします。
   • デプロイプロセスを監視し、問題が発生した場合は迅速に対処してください。

3. シークレットおよび環境変数:

   • APIキーやサーバーの認証情報などの機密情報は、GitHub Secretsとして保存してください。
   • これらのシークレットをGitHub Actionsのワークフローで使用し、安全なデプロイを実現してください。

• Node.js (推奨バージョン: 16.x以上)
• npm (パッケージマネージャとして使用)
• 任意のコードエディタ (例: VS Code

以下のコマンドを使用して、フロントエンドとバックエンドのリポジトリをクローンしてください。

# フロントエンドリポジトリ
git clone https://github.com/Brstcat/frontend.git
cd frontend

# 別のターミナルでバックエンドリポジトリ
git clone https://github.com/Brstcat/backend.git
cd backend

それぞれのリポジトリ内に .env ファイルを作成し、必要な環境変数を設定してください。 フロントエンド (frontend/.env)

mv .env.example .env

バックエンド (backend/.env)

mv .env.example .env

npm を使用して、フロントエンドとバックエンドそれぞれの依存パッケージをインストールしてください。

フロントエンド

   npm install

バックエンド

   npm install

以下のコマンドでそれぞれのサーバーを起動します。

バックエンドサーバー

cd backend
npm start

バックエンドサーバーは http://localhost:6001 で動作します。

フロントエンドサーバー

cd frontend
npm start

フロントエンドサーバーは http://localhost:3000 で動作します。

1. ミーティング:

   • 予定されたチームミーティングに出席し、積極的に参加してください。
   • 進捗状況を報告し、障害について議論してください。

2. Slack:

   • チームディスカッションのために指定されたコミュニケーションチャンネルを使用してください。

質問がある場合や支援が必要な場合は、プロジェクトマネージャーやチームリーダーに連絡してください。皆さんが効果的に貢献できるようにサポートします。