Erste Schritte
So leisten Sie erste Beiträge zu Wails v3
Willkommen, Mitwirkender!
Vielen Dank für Ihr Interesse, zu Wails beizutragen! Dieser Leitfaden hilft Ihnen bei Ihrem ersten Beitrag.
Voraussetzungen
Bevor Sie beginnen, stellen Sie sicher, dass Folgendes vorhanden ist:
- Go 1.25+ ist installiert (herunterladen)
- Node.js 20+ und npm (herunterladen)
- Git ist für Ihr GitHub-Konto konfiguriert
- Grundkenntnisse in Go und JavaScript/TypeScript
Plattformspezifische Anforderungen
macOS:
- Xcode Command Line Tools:
xcode-select --install
Windows:
- MSYS2 oder eine vergleichbare Unix-ähnliche Umgebung wird empfohlen
- WebView2-Laufzeitumgebung (unter Windows 11 normalerweise vorinstalliert)
Linux:
gcc,pkg-config,libgtk-4-dev,libwebkitgtk-6.0-dev(standardmäßiger GTK4-Stack)- Installation über:
sudo apt install build-essential pkg-config libgtk-4-dev libwebkitgtk-6.0-dev(Debian/Ubuntu) - Installieren Sie für den älteren
-tags gtk3-Build-Pfad zusätzlichlibgtk-3-devundlibwebkit2gtk-4.1-dev
Überblick über den Beitragsprozess
Der typische Arbeitsablauf für Beiträge umfasst folgende Schritte:
- Forken und klonen – Erstellen Sie eine eigene Kopie des Wails-Repositorys
- Einrichten – Erstellen Sie die Wails-CLI und überprüfen Sie Ihre Umgebung
- Branch erstellen – Erstellen Sie einen Feature-Branch für Ihre Änderungen
- Entwickeln – Nehmen Sie Ihre Änderungen gemäß unseren Codierungsstandards vor
- Testen – Führen Sie Tests aus, um sicherzustellen, dass alles funktioniert
- Committen – Committen Sie mit klaren Commit-Nachrichten nach Conventional Commits
- Einreichen – Öffnen Sie einen Pull Request zur Überprüfung
- Überarbeiten – Reagieren Sie auf Rückmeldungen und nehmen Sie Anpassungen vor
- Mergen – Nach der Freigabe werden Ihre Änderungen Teil von Wails!
Schritt-für-Schritt-Anleitung
Wählen Sie die Art Ihres Beitrags aus:
Fehler suchen oder melden
- Prüfen Sie, ob der Fehler bereits in den GitHub Issues gemeldet wurde
- Falls nicht, erstellen Sie ein neues Issue mit Schritten zum Reproduzieren des Fehlers
- Warten Sie auf eine Bestätigung, bevor Sie mit der Arbeit beginnen
Forken und klonen
Forken Sie das Repository unter github.com/wailsapp/wails/fork
Klonen Sie Ihren Fork:
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git
Erstellen und überprüfen
Erstellen Sie Wails und prüfen Sie, ob Sie den Fehler reproduzieren können:
cd v3
go build -o ../wails3 ./cmd/wails3
# Reproduce the bug to understand it
Branch für die Fehlerbehebung erstellen
Erstellen Sie einen Branch für Ihre Fehlerbehebung:
git checkout -b fix/issue-123-window-crash
Fehler beheben
- Nehmen Sie nur die minimal erforderlichen Änderungen vor, um den Fehler zu beheben
- Refaktorieren Sie keinen nicht betroffenen Code
- Fügen Sie Tests hinzu oder aktualisieren Sie sie, um Regressionen zu verhindern
# Make your changes
# Add tests in *_test.go files
Fehlerbehebung testen
Führen Sie Tests aus, um sicherzustellen, dass die Fehlerbehebung funktioniert:
go test ./...
# Test the specific package
go test ./pkg/application -v
# Run with race detector
go test ./... -race
Fehlerbehebung committen
Committen Sie mit einer klaren Nachricht:
git commit -m "fix: prevent window crash when closing during initialization
Fixes #123"
Pull Request einreichen
Pushen Sie Ihre Änderungen und erstellen Sie einen PR:
git push origin fix/issue-123-window-crash
Geben Sie in Ihrer PR-Beschreibung Folgendes an:
- Erläutern Sie den Fehler und seine Ursache
- Beschreiben Sie Ihre Fehlerbehebung
- Verweisen Sie auf das Issue: „Fixes #123“
- Beschreiben Sie das Verhalten vor und nach der Änderung
Auf Rückmeldungen reagieren
Bearbeiten Sie die Kommentare aus dem Review und aktualisieren Sie Ihren PR nach Bedarf.
WEP verfassen
- Lesen Sie den Prozess für WEPs (Wails Enhancement Proposals)
- Kopieren Sie die WEP-Vorlage nach
v3/wep/proposals/<name>/proposal.md - Öffnen Sie einen Entwurfs-PR mit dem Titel
[WEP] <title>, der ausschließlich das WEP enthält - Warten Sie vor der Implementierung auf die Entscheidung eines Maintainers
Forken und klonen
Forken Sie das Repository unter github.com/wailsapp/wails/fork
Klonen Sie Ihren Fork:
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git
Entwicklungsumgebung einrichten
Erstellen Sie Wails und überprüfen Sie Ihre Umgebung:
cd v3
go build -o ../wails3 ./cmd/wails3
# Run tests to ensure everything works
go test ./...
Feature-Branch erstellen
Erstellen Sie einen aussagekräftig benannten Branch:
git checkout -b feat/window-transparency-support
Feature implementieren
- Halten Sie sich an unsere Programmierrichtlinien
- Beschränken Sie die Änderungen auf das Feature
- Schreiben Sie sauberen, dokumentierten Code
- Fügen Sie umfassende Tests hinzu
# 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
Gründlich testen
Testen Sie Ihr Feature:
# 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
Feature dokumentieren
- Fügen Sie allen öffentlichen APIs Docstrings hinzu
- Aktualisieren Sie die relevante Dokumentation in
/docs/mpress/content/ - Fügen Sie gegebenenfalls Beispiele hinzu
Konventionsgemäß committen
Verwenden Sie Conventional Commits:
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"
Pull Request einreichen
Pushen Sie Ihre Änderungen und erstellen Sie einen PR:
git push origin feat/window-transparency-support
Geben Sie in Ihrem PR Folgendes an:
- Beschreiben Sie das Feature und seine Anwendungsfälle
- Zeigen Sie Beispiele oder Screenshots
- Führen Sie alle Breaking Changes auf
- Verweisen Sie auf den angenommenen WEP-PR
Änderungen nach dem Review überarbeiten
Die Maintainer können Änderungen anfordern. Bleiben Sie geduldig und arbeiten Sie konstruktiv mit ihnen zusammen.
PRs mit Korrekturen sind willkommen, ohne dass zuvor ein Issue geöffnet werden muss. Ausschließliche Dokumentationskorrekturen benötigen keinen fehlschlagenden Code-Test. Befolgen Sie für die Installation von M-Press, die Quellpfade, die Vorschau, die Validierung und die PR-Schritte die Anleitung Dokumentation korrigieren.
Issues zum Bearbeiten finden
- Suchen Sie nach
good first issue-Labels - Prüfen Sie
help wanted-Issues - Durchsuchen Sie die offenen Issues und bitten Sie darum, eines davon zugewiesen zu bekommen
Hilfe erhalten
- Discord: Treten Sie dem Wails-Discord bei
- Diskussionen: Veröffentlichen Sie einen Beitrag in den GitHub Discussions
- Issues: Öffnen Sie für einen reproduzierbaren Fehler ein Issue; verwenden Sie für Fragen die Discussions und für Erweiterungen einen WEP-PR
Verhaltenskodex
Seien Sie respektvoll, konstruktiv und offen. Gemeinsam bauen wir eine freundliche Community auf, deren Ziel es ist, hervorragende Software zu entwickeln.
Nächste Schritte
- Richten Sie Ihre Entwicklungsumgebung ein
- Lesen Sie unsere Programmierrichtlinien
- Sehen Sie sich die technische Dokumentation an