docs(contributing): in-repo guide covering v2 and v3#5269
Conversation
Replaces the one-line redirect with a brief, self-contained guide that points contributors at the right docs, changelog file, and discussion channel for each track. The wails.io community guide and v3.wails.io contributing page remain the canonical sources of detail; CONTRIBUTING.md is just the in-repo sign-post. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughThe CONTRIBUTING.md was expanded from a single-link reference into a full contribution guide defining two tracks (v2 stable and v3 alpha), track-specific locations for source/docs/changelogs, a v3 pre-discussion requirement, and a standardized pull request checklist. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/8 reviews remaining, refill in 58 minutes and 10 seconds.Comment |
github-actions
Bot
added
the
Documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
12-19: Strong v3 guidance; consider future-proofing the branch wording.Nice coverage of branch/docs/changelog/discussion expectations. Optional tweak: make the branch line less time-sensitive (or add a follow-up checkbox issue link) so this section doesn’t drift after the merge.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 12 - 19, Update the "## v3 (alpha)" section to avoid time-sensitive wording: replace the "Source: the `v3-alpha` branch (will move to the `v3/` directory on `master` after the v3 → master merge)" line with a future-proof phrasing such as "Source: `v3-alpha` branch (migrates to `v3/` on master after merge)" or add a follow-up checkbox/issue link note (e.g., "TODO: update branch reference after merge — see issue #") so the `## v3 (alpha)` heading and the "Source: the `v3-alpha` branch" bullet won’t become stale.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 12-19: Update the "## v3 (alpha)" section to avoid time-sensitive
wording: replace the "Source: the `v3-alpha` branch (will move to the `v3/`
directory on `master` after the v3 → master merge)" line with a future-proof
phrasing such as "Source: `v3-alpha` branch (migrates to `v3/` on master after
merge)" or add a follow-up checkbox/issue link note (e.g., "TODO: update branch
reference after merge — see issue #") so the `## v3 (alpha)` heading and the
"Source: the `v3-alpha` branch" bullet won’t become stale.
There was a problem hiding this comment.
Pull request overview
Updates the repository’s CONTRIBUTING.md to be a self-contained, in-repo signpost for contributing to the v2 (stable) vs v3 (alpha) tracks, pointing to the correct docs, changelog location, and discussion channel.
Changes:
- Replace the previous one-line redirect with an in-repo contributing guide covering v2 and v3.
- Add a v2/v3 breakdown (source location, docs, contributor guide, changelog target).
- Add a short PR checklist and a Code of Conduct pointer.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Source: the `v3-alpha` branch (will move to the `v3/` directory on `master` after the v3 → master merge). | ||
| - 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`. |
There was a problem hiding this comment.
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).
| - 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. |
|
|
||
| ## Code of conduct | ||
|
|
||
| By participating in this project you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
The CODE_OF_CONDUCT.md file is not present in the repository root, so this link will be broken on GitHub. Update the link to an existing Code of Conduct location (e.g., the repo's actual CoC file path) or add the missing CODE_OF_CONDUCT.md file.
| By participating in this project you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). | |
| By participating in this project you agree to abide by the Code of Conduct. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
18-18: Optional: verify Discord/feedback links render from GitHub.Per the PR test plan, it’d be good to double-check that the Discord invite and the “feedback guide” link resolve correctly when rendered in GitHub’s Markdown viewer (no redirect loops / 404s).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 18, Check the Markdown line that includes the Discord invite and feedback guide (the sentence starting "**Enhancements require prior discussion** on [Discord](https://discord.gg/JDdSxwjhGf) — see the [feedback guide](https://v3.wails.io/getting-started/feedback/)."); open it in GitHub's Markdown renderer to confirm both links resolve without redirects/404s, and if either link fails, update the URL to the correct invite or feedback guide path and commit the corrected Markdown.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- 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".
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 18: Check the Markdown line that includes the Discord invite and feedback
guide (the sentence starting "**Enhancements require prior discussion** on
[Discord](https://discord.gg/JDdSxwjhGf) — see the [feedback
guide](https://v3.wails.io/getting-started/feedback/)."); open it in GitHub's
Markdown renderer to confirm both links resolve without redirects/404s, and if
either link fails, update the URL to the correct invite or feedback guide path
and commit the corrected Markdown.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| ## v3 (alpha) | ||
|
|
||
| - Source: the `v3/` directory on tthe `master` branch. |
There was a problem hiding this comment.
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.
| - 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".
Summary
Replaces the one-line
CONTRIBUTING.mdredirect with a brief, self-contained guide that points contributors at the right docs, changelog file, and discussion channel for each track:masterand lives inv2/; v2 changelog iswebsite/src/pages/changelog.mdx.v3-alpha(will move tov3/onmasterafter the v3 → master merge); v3 changelog isv3/UNRELEASED_CHANGELOG.md.The detailed canonical guides on
wails.io/community-guideandv3.wails.io/contributing/are unchanged and linked from this file —CONTRIBUTING.mdis just the in-repo sign-post.Test plan
CONTRIBUTING.mdon github.com and confirm links work.v3-alpha" wording.🤖 Generated with Claude Code
Summary by CodeRabbit