はじめに
Wails v3 へのコントリビューションを始める方法
コントリビューターの皆さん、ようこそ！
Wails へのコントリビューションに関心をお寄せいただき、ありがとうございます。このガイドでは、初めてのコントリビューションを行う方法を説明します。
前提条件
始める前に、以下が準備できていることを確認してください。
- Go 1.25+ がインストール済みであること（ダウンロード）
- Node.js 20+ および npm（ダウンロード）
- Git が GitHub アカウント用に設定済みであること
- Go および JavaScript/TypeScript の基礎知識
プラットフォーム固有の要件
macOS：
- Xcode Command Line Tools：
xcode-select --install
Windows：
- MSYS2 または同様の Unix 系環境を推奨
- WebView2 ランタイム（通常は Windows 11 にプリインストール済み）
Linux：
gcc、pkg-config、libgtk-4-dev、libwebkitgtk-6.0-dev（デフォルトの GTK4 スタック）- 次のコマンドでインストール：
sudo apt install build-essential pkg-config libgtk-4-dev libwebkitgtk-6.0-dev（Debian/Ubuntu） - 従来の
-tags gtk3ビルドパスを使用する場合は、libgtk-3-devとlibwebkit2gtk-4.1-devもインストールしてください
コントリビューション手順の概要
一般的なコントリビューションのワークフローは、次の手順で進みます。
- フォークとクローン - Wails リポジトリの自分用のコピーを作成します
- セットアップ - Wails CLI をビルドし、環境を検証します
- ブランチ作成 - 変更用の機能ブランチを作成します
- 開発 - コーディング規約に従って変更を加えます
- テスト - テストを実行し、すべてが正しく動作することを確認します
- コミット - 明確で Conventional Commits に準拠したメッセージを付けてコミットします
- 提出 - レビュー用のプルリクエストを作成します
- 修正の反復 - フィードバックに対応し、必要な調整を行います
- マージ - 承認されると、変更が Wails に取り込まれます！
ステップ別ガイド
コントリビューションの種類を選択してください。
1
バグを探す、または報告する
- そのバグが GitHub Issues ですでに報告されていないか確認してください
- 報告されていない場合は、再現手順を記載した新しい Issue を作成してください
- 作業を開始する前に確認を待ってください
2
フォークとクローン
github.com/wailsapp/wails/fork でリポジトリをフォークしてください
フォークをクローンします。
bash
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git
3
ビルドと検証
Wails をビルドし、バグを再現できることを確認します。
bash
cd v3
go build -o ../wails3 ./cmd/wails3
# Reproduce the bug to understand it
4
バグ修正用ブランチの作成
修正用のブランチを作成します。
bash
git checkout -b fix/issue-123-window-crash
5
バグの修正
- バグの修正に必要な最小限の変更を加えてください
- 無関係なコードをリファクタリングしないでください
- リグレッションを防ぐため、テストを追加または更新してください
bash
# Make your changes
# Add tests in *_test.go files
6
修正のテスト
テストを実行し、修正が機能することを確認します。
bash
go test ./...
# Test the specific package
go test ./pkg/application -v
# Run with race detector
go test ./... -race
7
修正のコミット
明確なメッセージを付けてコミットします。
bash
git commit -m "fix: prevent window crash when closing during initialization
Fixes #123"
8
プルリクエストの提出
プッシュして PR を作成します。
bash
git push origin fix/issue-123-window-crash
PR の説明には、以下を記載してください。
- バグと根本原因を説明する
- 修正内容を説明する
- Issue を参照する：“Fixes #123”
- 修正前と修正後の動作を記載する
9
フィードバックへの対応
レビューコメントに対応し、必要に応じて PR を更新してください。
1
WEP の作成
- WEP（Wails Enhancement Proposal）のプロセスを確認してください
- WEP テンプレートを
v3/wep/proposals/<name>/proposal.mdにコピーしてください - タイトルを
[WEP] <title>とし、WEP のみを含むドラフト PR を作成してください - 実装を開始する前に、メンテナーの決定を待ってください
2
フォークとクローン
github.com/wailsapp/wails/fork でリポジトリをフォークしてください
フォークをクローンします。
bash
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git
3
開発環境をセットアップする
Wails をビルドし、環境を検証します。
bash
cd v3
go build -o ../wails3 ./cmd/wails3
# Run tests to ensure everything works
go test ./...
4
機能ブランチを作成する
内容が分かりやすい名前のブランチを作成します。
bash
git checkout -b feat/window-transparency-support
5
機能を実装する
- コーディング規約に従う
- 変更を対象の機能に限定する
- 明確で、適切に文書化されたコードを書く
- 包括的なテストを追加する
bash
# Example: Adding a new window method
# 1. Add to window.go interface
# 2. Implement in platform files (darwin, windows, linux)
# 3. Add tests
# 4. Update documentation
6
十分にテストする
機能をテストします。
bash
# Unit tests
go test ./pkg/application -v
# Integration test - create a test app
cd ..
./wails3 init -n feature-test
cd feature-test
# Add code using your new feature
../wails3 dev
7
機能を文書化する
- すべての公開 API に docstring を追加する
/docs/mpress/content/内の関連ドキュメントを更新する- 該当する場合は例を追加する
8
規約に従ってコミットする
Conventional Commits を使用します。
bash
git commit -m "feat: add window transparency support
- Add SetTransparent() method to Window API
- Implement for macOS, Windows, and Linux
- Add tests and documentation
Closes #456"
9
プルリクエストを提出する
プッシュして PR を作成します。
bash
git push origin feat/window-transparency-support
PR には次の内容を含めます。
- 機能とユースケースを説明する
- 例またはスクリーンショットを提示する
- 破壊的変更があればすべて列挙する
- 承認済みの WEP PR を参照する
10
レビューに基づいて修正を重ねる
メンテナーから変更を求められる場合があります。辛抱強く、協力的に対応してください。
修正 PR は、事前に issue を作成しなくても歓迎します。ドキュメントのみの修正では、失敗するコードテストは必要ありません。M-Press のインストール、ソースパス、プレビュー、検証、PR の各手順については、ドキュメントを修正するに従ってください。
取り組む issue を探す
good first issueラベルを探すhelp wantedissue を確認する- 未解決の issueを確認し、担当への割り当てを依頼する
サポートを受ける
- Discord：Wails Discord に参加する
- Discussions：GitHub Discussions に投稿する
- Issues：再現可能なバグについては issue を作成する。質問には Discussions、機能強化には WEP PR を使用する
行動規範
相手を尊重し、建設的かつ友好的に接してください。私たちは、優れたソフトウェアを共に作ることに注力する、親しみやすいコミュニティを築いています。