Bedrudへのコントリビューションをお待ちしております。このガイドでは変更を提出するまでのプロセスについて説明します。

注意： 公式のコントリビューションガイドはリポジトリのルートにあります：CONTRIBUTING.md。このページは参考用としてアーカイブされています。

はじめに

1. リポジトリをフォークします
2. フォークをクローンします
3. main からフィーチャーブランチを作成します
4. 変更を加えます
5. プルリクエストを提出します

前提条件

• Go 1.22+
• Bun（Webフロントエンド用）
• Rust（デスクトップアプリ用）
• Make
• Git

開発環境のセットアップ

# GitHubでフォークした後、フォークをクローン
git clone https://github.com/<your-username>/bedrud.git
cd bedrud
make init
make dev

詳細なセットアップ手順については、開発ワークフローを参照してください。

プロジェクト構成

コードスタイル

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

1. ブランチの命名： feature/description、fix/description、または docs/description
2. コミットメッセージ： <action> <what> for <why>（例：add user model for auth feature、fix login redirect for expired sessions）
3. CIチェック： すべてのGitHub Actionsチェックをパスする必要があります
4. 説明： 変更内容と理由を含めてください

CIチェック

すべてのPRで以下のチェックが自動的に実行されます：

バグ報告

GitHub Issuesに以下の情報を含めてIssueを報告してください：

• 再現手順
• 期待される動作と実際の動作
• 環境情報（OS、ブラウザ、アプリバージョン）

ドキュメント

ドキュメントは docs/ ディレクトリにあり、MkDocs Material でビルドされています。

ローカルプレビュー

pip install mkdocs-material
mkdocs serve

その後、ブラウザで http://localhost:8000 を開きます。

構成

ドキュメントページはトピックごとに整理されています。ナビゲーションはプロジェクトルートの mkdocs.yml で定義されています。

ライセンス

コントリビューションすることで、あなたの贡献物がApache License 2.0の下でライセンスされることに同意したものとみなされます。