Getting Started

• Check if the bug is already reported in GitHub Issues
• If not, create a new issue with steps to reproduce
• Wait for confirmation before starting work

Fork the repository at github.com/wailsapp/wails/fork

Clone your fork:

git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git

Build Wails and verify you can reproduce the bug:

cd v3
go build -o ../wails3 ./cmd/wails3

# Reproduce the bug to understand it

Create a branch for your fix:

git checkout -b fix/issue-123-window-crash

• Make the minimal changes needed to fix the bug
• Don’t refactor unrelated code
• Add or update tests to prevent regression

# Make your changes
# Add tests in *_test.go files

Run tests to ensure the fix works:

go test ./...

# Test the specific package
go test ./pkg/application -v

# Run with race detector
go test ./... -race

Commit with a clear message:

git commit -m "fix: prevent window crash when closing during initialization

Fixes #123"

Push and create PR:

git push origin fix/issue-123-window-crash

In your PR description:

• Explain the bug and root cause
• Describe your fix
• Reference the issue: “Fixes #123”
• Include before/after behavior

Address review comments and update your PR as needed.

• Read the WEP (Wails Enhancement Proposal) process
• Copy the WEP template into v3/wep/proposals/<name>/proposal.md
• Open a draft PR titled [WEP] <title> containing the WEP only
• Wait for a maintainer decision before implementing

Fork the repository at github.com/wailsapp/wails/fork

Clone your fork:

git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git

Build Wails and verify your environment:

cd v3
go build -o ../wails3 ./cmd/wails3

# Run tests to ensure everything works
go test ./...

Create a descriptive branch:

git checkout -b feat/window-transparency-support

• Follow our Coding Standards
• Keep changes focused on the feature
• Write clean, documented code
• Add comprehensive tests

# 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

Test your 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

• Add docstrings to all public APIs
• Update relevant documentation in /docs/src/content/docs/
• Add examples if applicable

Use 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"

Push and create PR:

git push origin feat/window-transparency-support

In your PR:

• Describe the feature and use cases
• Show examples or screenshots
• List any breaking changes
• Reference the accepted WEP PR

Maintainers may request changes. Be patient and collaborative.

• Found outdated docs while using Wails?
• Notice missing examples or explanations?
• Want to fix typos or improve clarity?
• Check documentation issues

Fork the repository at github.com/wailsapp/wails/fork

Clone your fork:

git clone https://github.com/YOUR_USERNAME/wails.git
cd wails
git remote add upstream https://github.com/wailsapp/wails.git

The docs are in /docs/src/content/docs/ and built with Astro:

cd docs
npm install
npm run dev

Open http://localhost:4321/ to preview changes live.

Create a branch for your changes:

git checkout -b docs/improve-window-api-examples

Documentation files are in /docs/src/content/docs/:

# Edit MDX files
# Check the preview in your browser
# Ensure formatting is correct

Best Practices:

• Use clear, concise language
• Include practical code examples
• Add links to related sections
• Check spelling and grammar
• Test all code examples

Check the live preview and ensure:

• Links work correctly
• Code examples are accurate
• Formatting renders properly
• No broken images or references

Commit with clear message:

git commit -m "docs: add practical examples to Window API guide

- Add window positioning examples
- Include common patterns section
- Fix broken links to Event API"

Push and create PR:

git push origin docs/improve-window-api-examples

In your PR:

• Describe what docs you improved
• Explain why the change helps users
• Include screenshots if visual changes

Documentation PRs are usually quick to review and merge!