You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(wep): add index, statuses, numbering and platform section to the WEP process
Implements the process improvements agreed with the maintainer:
- WEP Index table in the README (number, title, status, discussion,
implementation) with documented status values
- Metadata header in the template (number, status, discussion link,
implementor) and a Platform Considerations section
- 'Do I Need a WEP?' section defining when a proposal is required
- Support is now measured by upvotes on the Enhancement Proposals
discussion rather than thumbs-ups on a draft PR
- Decisions recorded in a standard comment format; rejected proposals
stay findable via the index
- Accepted proposals not started within 3 months become up for grabs
- Migrated the existing proposal as WEP 0001 (dir renamed to
0001-titlebar-buttons, header added, status Implemented via #3508)
Copy file name to clipboardExpand all lines: docs/src/content/docs/contributing.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Substantial new functionality goes through the Wails Enhancement Proposal (WEP)
45
45
1. Discuss your idea in the [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) category on GitHub Discussions. This is the official place to discuss proposals. The [#enhancement-proposals](https://discord.gg/TA8kbQds95) channel on Discord is a good place for informal chat about it too.
46
46
2. Copy [`v3/wep/WEP_TEMPLATE.md`](https://github.com/wailsapp/wails/blob/master/v3/wep/WEP_TEMPLATE.md) to `v3/wep/proposals/<proposal name>/proposal.md` and fill in every section.
47
47
3. Open a draft pull request titled `[WEP] <title>` containing only the proposal, and link it from your discussion thread.
48
-
4. Gather feedback and support (thumbs-up reactions on the PR). Allow at least two weeks for discussion, and agree on who will implement the proposal.
48
+
4. Gather feedback and support (upvotes on the discussion). Allow at least two weeks for discussion, and agree on who will implement the proposal.
49
49
5. Mark the PR ready for review. The maintainers make the final decision: accepted proposals are assigned a WEP number and merged.
50
50
51
51
The full process is documented in [`v3/wep/README.md`](https://github.com/wailsapp/wails/blob/master/v3/wep/README.md).
Copy file name to clipboardExpand all lines: v3/wep/README.md
+35-5Lines changed: 35 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,15 @@ Following this structured approach ensures transparency, community involvement,
11
11
12
12
**NOTE**: This process is for proposing new functionality. For bug fixes, documentation improvements, and other minor changes, please follow the standard PR process.
13
13
14
+
## Do I Need a WEP?
15
+
16
+
Not every change needs a proposal. As a rule of thumb:
17
+
18
+
-**WEP required**: new public API, changes to existing API behaviour, breaking changes, new cross-platform functionality, or anything involving significant platform-specific work.
19
+
-**No WEP needed**: bug fixes, documentation, small additive options, internal refactoring. Use the standard PR process.
20
+
21
+
If you are unsure, start a discussion in the [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) category and ask.
22
+
14
23
## Submission of Proposal
15
24
16
25
### 1. Idea Initiation
@@ -33,7 +42,7 @@ Following this structured approach ensures transparency, community involvement,
33
42
34
43
-**Share Your Proposal**: Link the PR from your discussion in the [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) category (or start one if you haven't yet). Try to get support for the proposal to increase the chances of acceptance. If you are on the discord server, you are also welcome to share it in the [`#enhancement-proposals`](https://discord.gg/TA8kbQds95) channel, but GitHub Discussions is the official venue.
35
44
-**Gather Feedback**: Refine your proposal based on community input. Feedback on the proposal text itself should be added as comments on the PR so it stays with the document; broader discussion belongs in the discussion thread.
36
-
-**Show Support**: Agreement with the proposal should be indicated by adding a thumbs-up emoji to the PR. The more thumbs-up emojis, the more likely the proposal will be accepted.
45
+
-**Show Support**: Agreement with the proposal should be indicated by upvoting the discussion in the Enhancement Proposals category. The more support a proposal has, the more likely it is to be accepted.
37
46
-**Iterate**: Make changes to the proposal based on feedback.
38
47
-**Agree on an Implementor**: To avoid stagnant proposals, we require someone agree to implement it. This could be the proposer.
39
48
-**Ready for Review**: Once the proposal is ready for review, change the PR status to `Ready for Review`.
@@ -42,11 +51,20 @@ A minimum of 2 weeks should be given for community feedback and discussion.
42
51
43
52
### 4. Final Decision
44
53
45
-
-**Decision**: The Wails maintainers will make a final decision on the proposal based on community feedback and the proposal's merits.
46
-
- If accepted, the proposal will be assigned a WEP number and the PR merged.
47
-
- If rejected, the reasons will be provided in the PR comments.
54
+
-**Decision**: The Wails maintainers will make a final decision on the proposal based on community feedback and the proposal's merits. The decision is recorded as a comment on the PR in this format:
55
+
56
+
```
57
+
**Decision**: Accepted / Rejected
58
+
**Decided by**: @maintainer(s)
59
+
**Rationale**: A short explanation of the decision.
60
+
```
61
+
62
+
-**If accepted**:
63
+
- The proposal is assigned the next WEP number and its directory renamed to `NNNN-<name of proposal>`.
64
+
- The proposal's status is updated to `Accepted`, it is added to the [WEP Index](#wep-index), and the PR is merged.
65
+
-**If rejected**: The PR is closed and the proposal recorded in the [WEP Index](#wep-index) with a link to the decision, so the outcome is easy to find if the idea comes up again.
48
66
49
-
*NOTE*: If a proposal has not met the required support or has been inactive for more than a month, it may be closed.
67
+
*NOTE*: If a proposal has not met the required support or has been inactive for more than a month, it may be closed as `Withdrawn`.
50
68
51
69
## Implementation of Proposal
52
70
@@ -67,4 +85,16 @@ Once a proposal has been accepted and an implementation plan has been decided, t
67
85
68
86
-**Review of PR**: Address any review comments.
69
87
-**Merge**: The PR will be merged after satisfactory review.
88
+
-**Update the Status**: When the implementation PR merges, update the proposal's status to `Implemented` and add the implementation PR to the [WEP Index](#wep-index).
89
+
90
+
*NOTE*: Acceptance requires a committed implementor. If implementation has not started within 3 months of acceptance, the proposal is marked as up for grabs in the WEP Index and anyone may take it on.
91
+
92
+
## WEP Index
93
+
94
+
| WEP | Title | Status | Discussion | Implementation |
**Statuses**: `Draft` (under discussion), `Accepted` (approved, awaiting implementation), `Implemented` (shipped), `Rejected` (declined), `Withdrawn` (closed by the author or for inactivity).
99
+
70
100
The WEP process ensures structured and collaborative enhancement of Wails. Adhere to this guide to contribute effectively to the project's growth.
0 commit comments