-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1 +1,29 @@ | ||||||
| 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-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`. | ||||||
| - **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. | ||||||
|
|
||||||
| ## Code of conduct | ||||||
|
|
||||||
| 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](CODE_OF_CONDUCT.md). | |
| By participating in this project you agree to abide by the Code of Conduct. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
v3/UNRELEASED_CHANGELOG.mddoes not exist in this repo/branch (currentv3/only containsscripts/), so this instruction will be a dead-end when reading CONTRIBUTING onmaster. Consider pointing to an existing file, or clarifying the exact path on thev3-alphabranch (and/or linking to the canonical v3 contributing page for changelog instructions).