Bien démarrer
Comment commencer à contribuer à Wails v3
Bienvenue, contributrice ou contributeur !
Merci de votre intérêt pour la contribution à Wails ! Ce guide vous aidera à apporter votre première contribution.
Prérequis
Avant de commencer, vérifiez que vous disposez des éléments suivants :
- Go 1.25+ installé (télécharger)
- Node.js 20+ et npm (télécharger)
- Git configuré avec votre compte GitHub
- Connaissances de base en Go et en JavaScript/TypeScript
Prérequis propres à chaque plateforme
macOS :
- Outils en ligne de commande de Xcode :
xcode-select --install
Windows :
- MSYS2 ou un environnement similaire de type Unix est recommandé
- Runtime WebView2 (généralement préinstallé sous Windows 11)
Linux :
gcc,pkg-config,libgtk-4-dev,libwebkitgtk-6.0-dev(pile GTK4 par défaut)- Installez-les avec :
sudo apt install build-essential pkg-config libgtk-4-dev libwebkitgtk-6.0-dev(Debian/Ubuntu) - Pour l’ancien processus de compilation
-tags gtk3, installez égalementlibgtk-3-devetlibwebkit2gtk-4.1-dev
Vue d’ensemble du processus de contribution
Le processus de contribution habituel comprend les étapes suivantes :
- Fork et clonage — Créez votre propre copie du dépôt Wails
- Configuration — Compilez la CLI Wails et vérifiez votre environnement
- Branche — Créez une branche de fonctionnalité pour vos modifications
- Développement — Effectuez vos modifications en respectant nos conventions de codage
- Tests — Exécutez les tests pour vérifier que tout fonctionne
- Commit — Enregistrez vos modifications avec des messages de commit clairs et conventionnels
- Soumission — Ouvrez une pull request pour révision
- Itération — Répondez aux retours et apportez les ajustements nécessaires
- Fusion — Une fois approuvées, vos modifications sont intégrées à Wails !
Guide étape par étape
Choisissez votre type de contribution :
Rechercher ou signaler le bug
- Vérifiez si le bug a déjà été signalé dans les issues GitHub
- Sinon, créez une nouvelle issue en indiquant les étapes permettant de reproduire le bug
- Attendez une confirmation avant de commencer le travail
Créer un fork et le cloner
Créez un fork du dépôt à l’adresse github.com/wailsapp/wails/fork
Clonez votre fork :
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git
Compiler et vérifier
Compilez Wails et vérifiez que vous pouvez reproduire le bug :
cd v3
go build -o ../wails3 ./cmd/wails3
# Reproduce the bug to understand it
Créer une branche de correction
Créez une branche pour votre correction :
git checkout -b fix/issue-123-window-crash
Corriger le bug
- Effectuez uniquement les modifications minimales nécessaires pour corriger le bug
- Ne remaniez pas de code sans rapport avec le bug
- Ajoutez ou mettez à jour des tests pour éviter toute régression
# Make your changes
# Add tests in *_test.go files
Tester votre correction
Exécutez les tests pour vérifier que la correction fonctionne :
go test ./...
# Test the specific package
go test ./pkg/application -v
# Run with race detector
go test ./... -race
Enregistrer votre correction
Créez un commit avec un message clair :
git commit -m "fix: prevent window crash when closing during initialization
Fixes #123"
Soumettre une pull request
Poussez vos modifications et créez une PR :
git push origin fix/issue-123-window-crash
Dans la description de votre PR :
- Expliquez le bug et sa cause première
- Décrivez votre correction
- Référencez l’issue : « Fixes #123 »
- Indiquez le comportement avant et après la correction
Répondre aux retours
Traitez les commentaires de révision et mettez à jour votre PR si nécessaire.
Rédiger une WEP
- Consultez le processus WEP (Wails Enhancement Proposal)
- Copiez le modèle de WEP dans
v3/wep/proposals/<name>/proposal.md - Ouvrez une PR en brouillon intitulée
[WEP] <title>et contenant uniquement la WEP - Attendez la décision d’un responsable de maintenance avant de commencer l’implémentation
Créer un fork et le cloner
Créez un fork du dépôt à l’adresse github.com/wailsapp/wails/fork
Clonez votre fork :
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git
Configurer l’environnement de développement
Compilez Wails et vérifiez votre environnement :
cd v3
go build -o ../wails3 ./cmd/wails3
# Run tests to ensure everything works
go test ./...
Créer une branche de fonctionnalité
Créez une branche au nom descriptif :
git checkout -b feat/window-transparency-support
Implémenter la fonctionnalité
- Respectez nos normes de codage
- Limitez les modifications à la fonctionnalité
- Écrivez du code clair et documenté
- Ajoutez des tests complets
# 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
Tester minutieusement
Testez votre fonctionnalité :
# 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
Documenter votre fonctionnalité
- Ajoutez des chaînes de documentation à toutes les API publiques
- Mettez à jour la documentation pertinente dans
/docs/mpress/content/ - Ajoutez des exemples, le cas échéant
Respecter la convention de commit
Utilisez des commits conventionnels :
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"
Soumettre une pull request
Poussez la branche et créez une PR :
git push origin feat/window-transparency-support
Dans votre PR :
- Décrivez la fonctionnalité et ses cas d’utilisation
- Présentez des exemples ou des captures d’écran
- Répertoriez toutes les modifications incompatibles
- Faites référence à la PR WEP acceptée
Apporter des modifications en fonction de la revue
Les responsables de la maintenance peuvent demander des modifications. Faites preuve de patience et coopérez.
Les PR de correction sont les bienvenues sans qu’il soit nécessaire d’ouvrir d’abord une issue. Les corrections portant uniquement sur la documentation ne nécessitent pas de test de code en échec. Suivez Corriger la documentation pour connaître les étapes d’installation de M-Press, les chemins des sources, ainsi que les étapes de prévisualisation, de validation et de création d’une PR.
Trouver des issues sur lesquelles travailler
- Recherchez les labels
good first issue - Consultez les issues
help wanted - Parcourez les issues ouvertes et demandez qu’elles vous soient attribuées
Obtenir de l’aide
- Discord : rejoignez le Discord de Wails
- Discussions : publiez un message dans les discussions GitHub
- Issues : ouvrez une issue pour un bug reproductible ; utilisez les Discussions pour les questions et une PR WEP pour les améliorations
Code de conduite
Soyez respectueux, constructifs et accueillants. Nous bâtissons une communauté conviviale dont l’objectif est de créer ensemble d’excellents logiciels.
Étapes suivantes
- Configurez votre environnement de développement
- Consultez nos normes de codage
- Explorez la documentation technique