Skip to content

docs(contributing): in-repo guide covering v2 and v3 #5269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leaanthony merged 3 commits into from
Apr 29, 2026
Merged

docs(contributing): in-repo guide covering v2 and v3 #5269

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80487a5
docs(contributing): in-repo guide covering v2 and v3
leaanthony Apr 29, 2026
361fcc2
fix
leaanthony Apr 29, 2026
0795c3f
Merge branch 'master' into docs/contributing-v2-v3
leaanthony Apr 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
The current Contribution Guidelines can be found at: https://wails.io/community-guide
# Contributing to Wails

Thanks for your interest in contributing! Wails has two active tracks. Pick the one that matches the change you want to make.

## v2 (stable)

- Source: the `v2/` directory on the `master` branch.
- Docs: [wails.io](https://wails.io/).
- Detailed contributor guide: [wails.io/community-guide](https://wails.io/community-guide).
- Changelog: update `website/src/pages/changelog.mdx` under the `[Unreleased]` heading.

## v3 (alpha)

- Source: the `v3/` directory on tthe `master` branch.

@coderabbitai coderabbitai Bot Apr 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typo: “tthe” → “the” (v3 source track).

Line 14 has a spelling error: “on tthe master branch” should be “on the master branch”. This is small but directly affects a contributor-facing sign-post guide.

🐛 Proposed fix 
- - Source: the `v3/` directory on tthe `master` branch.
+ - Source: the `v3/` directory on the `master` branch.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Source: the `v3/` directory on tthe `master` branch.
- Source: the `v3/` directory on the `master` branch.
🧰 Tools
🪛 LanguageTool

[grammar] ~14-~14: Ensure spelling is correct
Context: ...lpha) - Source: the v3/ directory on tthe master branch. - Docs: [v3.wails.io](...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` at line 14, Fix the typo in CONTRIBUTING.md by changing the
phrase "Source: the `v3/` directory on tthe `master` branch." to "Source: the
`v3/` directory on the `master` branch." — locate the exact string "Source: the
`v3/` directory on tthe `master` branch." and correct "tthe" to "the".

- Docs: [v3.wails.io](https://v3.wails.io/).
- Detailed contributor guide: [v3.wails.io/contributing](https://v3.wails.io/contributing/).
- Changelog: update `v3/UNRELEASED_CHANGELOG.md`.

Copilot AI Apr 29, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v3/UNRELEASED_CHANGELOG.md does not exist in this repo/branch (current v3/ only contains scripts/), so this instruction will be a dead-end when reading CONTRIBUTING on master. Consider pointing to an existing file, or clarifying the exact path on the v3-alpha branch (and/or linking to the canonical v3 contributing page for changelog instructions).

Suggested change
- Changelog: update `v3/UNRELEASED_CHANGELOG.md`.
- Changelog: follow the current changelog instructions in the [v3 contributing guide](https://v3.wails.io/contributing/), since the exact file path is branch-specific.

Copilot uses AI. Check for mistakes.
- **Enhancements require prior discussion** on [Discord](https://discord.gg/JDdSxwjhGf) — see the [feedback guide](https://v3.wails.io/getting-started/feedback/).

## Pull request checklist

- One feature or fix per PR.
- Update the relevant changelog file (see above).
- Follow the existing coding style in the area you're touching.
- Add tests where it makes sense.
Loading