2025年1月1日

Roxへの貢献

Roxへの貢献に関心をお寄せいただきありがとうございます！Roxをより良くするために、コミュニティからの貢献を歓迎します。

行動規範

このプロジェクトに参加することで、行動規範（Code of Conduct）に従うことに同意したことになります。すべての人に敬意と優しさを持って接してください。

はじめに

前提条件

  • Bun: v1.0.0 以上
  • Node.js: v18 以上（一部のツール用）
  • Docker: データベースとサービスの実行用

環境セットアップ

  1. GitHubでリポジトリをフォークします。
  2. フォークをクローンします： 
    git clone https://github.com/YOUR_USERNAME/rox.git
cd rox
  3. 依存関係をインストールします： 
    bun install
  4. データベースを起動します： 
    docker compose up -d
  5. マイグレーションを実行します： 
    bun run db:migrate
  6. 開発サーバーを起動します： 
    bun run dev

バックエンドAPIは http://localhost:3000、フロントエンドクライアントは http://localhost:3001 で利用可能になります。

開発ワークフロー

  1. 機能または修正のためのブランチを作成します： 
    git checkout -b feature/my-new-feature
  2. 変更を加えます。プロジェクトのコーディングスタイルに従ってください。
  3. テストを実行して、リグレッションがないことを確認します： 
    bun test
  4. Conventional Commitsを使用して変更をコミットします： 
    git commit -m "feat: add new awesome feature"
  5. フォークにプッシュします： 
    git push origin feature/my-new-feature
  6. メインリポジトリに対してプルリクエストを作成します。

プロジェクト構造

  • src/backend: Hono APIサーバー
  • src/frontend: Wakuクライアントアプリケーション
  • src/shared: 共有型とユーティリティ
  • drizzle: データベーススキーマとマイグレーション

問題の報告

バグを見つけた場合や機能リクエストがある場合は、GitHubでIssueを開いてください。再現手順など、できるだけ詳細な情報を提供してください。

ライセンス

貢献することで、あなたの貢献がプロジェクトのMITライセンスの下でライセンスされることに同意したことになります。