Skip to content

Commit 850f08b

Browse files
committed
docs(wep): the WEP PR is the single discussion venue
Per maintainer decision: proposals are discussed on the WEP PR itself (comments for feedback, thumbs-up reactions for support), not in a separate discussion thread. Pre-proposal ideas can optionally be floated in the Ideas category on GitHub Discussions or on Discord. Index column Discussion renamed to Proposal.
1 parent 42d90fc commit 850f08b

7 files changed

Lines changed: 15 additions & 15 deletions

File tree

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
attributes:
99
value: |
1010
Before opening a feature request, please check the [Roadmap](https://github.com/wailsapp/wails/discussions/1484) to see if it has already been requested.
11-
***Please note: Enhancements should be discussed in [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) on GitHub Discussions (or on [Discord](https://discord.gg/JDdSxwjhGf)) before opening a feature request. Substantial new functionality should be submitted as a [Wails Enhancement Proposal (WEP)](https://github.com/wailsapp/wails/blob/master/v3/wep/README.md). See the [feedback guide](https://v3.wails.io/feedback/) for details.***
11+
***Please note: Enhancements should be discussed in [Ideas](https://github.com/wailsapp/wails/discussions/categories/ideas) on GitHub Discussions or on [Discord](https://discord.gg/JDdSxwjhGf) before opening a feature request. Substantial new functionality should be submitted as a [Wails Enhancement Proposal (WEP)](https://github.com/wailsapp/wails/blob/master/v3/wep/README.md). See the [feedback guide](https://v3.wails.io/feedback/) for details.***
1212
1313
- type: textarea
1414
attributes:

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Thanks for your interest in contributing! Wails has two active tracks. Pick the
1515
- Docs: [v3.wails.io](https://v3.wails.io/).
1616
- Detailed contributor guide: [v3.wails.io/contributing](https://v3.wails.io/contributing/).
1717
- Changelog: v3 entries are added automatically from your PR on merge. To control the wording, add your own entry to `v3/UNRELEASED_CHANGELOG.md` and the automation will use it instead.
18-
- **Enhancements require prior discussion** in [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) on GitHub Discussions (see the [feedback guide](https://v3.wails.io/feedback/)). Substantial new functionality goes through the [Wails Enhancement Proposal (WEP) process](v3/wep/README.md).
18+
- **Enhancements require prior discussion** in [Ideas](https://github.com/wailsapp/wails/discussions/categories/ideas) on GitHub Discussions (see the [feedback guide](https://v3.wails.io/feedback/)). Substantial new functionality goes through the [Wails Enhancement Proposal (WEP) process](v3/wep/README.md).
1919

2020
## Pull request checklist
2121

docs/src/content/docs/contributing.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ Contribute code through pull requests:
4242

4343
Substantial new functionality goes through the Wails Enhancement Proposal (WEP) process. It keeps feature development transparent and ensures every accepted proposal has community support and an implementor. In short:
4444

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.
45+
1. Optionally float your idea in the [Ideas](https://github.com/wailsapp/wails/discussions/categories/ideas) category on GitHub Discussions or on [Discord](https://discord.gg/JDdSxwjhGf) to gauge interest.
4646
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-
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 (upvotes on the discussion). Allow at least two weeks for discussion, and agree on who will implement the proposal.
47+
3. Open a draft pull request titled `[WEP] <title>` containing only the proposal. The PR is the official place to discuss it.
48+
4. Gather feedback and support (comments and thumbs-up reactions on the PR). Allow at least two weeks for discussion, and agree on who will implement the proposal.
4949
5. Mark the PR ready for review. The maintainers make the final decision: accepted proposals are assigned a WEP number and merged.
5050

5151
The full process is documented in [`v3/wep/README.md`](https://github.com/wailsapp/wails/blob/master/v3/wep/README.md).

docs/src/content/docs/feedback.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ discussions before creating new ones. Here are the different ways to contribute:
4747

4848
- Clearly describe the feature and the problem it solves.
4949
- Feel free to also discuss ideas in the [#v3](https://discord.gg/bdj28QNHmT) channel on Discord.
50-
- Substantial new functionality goes through the [Wails Enhancement Proposal (WEP) process](https://github.com/wailsapp/wails/blob/master/v3/wep/README.md), a structured proposal that is discussed with the community before being accepted for implementation. Proposals are discussed in the [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) category on GitHub Discussions. See the [contributing guide](/contributing/#4-propose-an-enhancement-wep) for a summary.
50+
- Substantial new functionality goes through the [Wails Enhancement Proposal (WEP) process](https://github.com/wailsapp/wails/blob/master/v3/wep/README.md), a structured proposal that is discussed with the community on its pull request before being accepted for implementation. See the [contributing guide](/contributing/#4-propose-an-enhancement-wep) for a summary.
5151

5252
</TabItem>
5353

v3/wep/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Not every change needs a proposal. As a rule of thumb:
1818
- **WEP required**: new public API, changes to existing API behaviour, breaking changes, new cross-platform functionality, or anything involving significant platform-specific work.
1919
- **No WEP needed**: bug fixes, documentation, small additive options, internal refactoring. Use the standard PR process.
2020

21-
If you are unsure, start a discussion in the [Enhancement Proposals](https://github.com/wailsapp/wails/discussions/categories/enhancement-proposals) category and ask.
21+
If you are unsure, ask in the [Ideas](https://github.com/wailsapp/wails/discussions/categories/ideas) category on GitHub Discussions or on [Discord](https://discord.gg/JDdSxwjhGf).
2222

2323
## Submission of Proposal
2424

2525
### 1. Idea Initiation
2626

27-
- **Discuss Your Idea**: Before writing a proposal, start a discussion 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. It helps gauge interest, catch overlap with existing plans, and shape the idea before you invest time in writing it up.
27+
- **Gauge Interest (optional)**: Before writing a proposal, consider floating the idea in the [Ideas](https://github.com/wailsapp/wails/discussions/categories/ideas) category on GitHub Discussions or on [Discord](https://discord.gg/JDdSxwjhGf). It can catch overlap with existing plans before you invest time in a write-up.
2828
- **Document Your Idea**:
2929
- Create a new directory: `v3/wep/proposals/<name of proposal>` with the name of your proposal.
3030
- Copy the WEP template located in `v3/wep/WEP_TEMPLATE.md` into `v3/wep/proposals/<name of proposal>/proposal.md`.
@@ -40,9 +40,9 @@ If you are unsure, start a discussion in the [Enhancement Proposals](https://git
4040

4141
### 3. Community Discussion
4242

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.
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.
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.
43+
- **Share Your Proposal**: The PR is the official place to discuss the proposal. Present it to the Wails community and try to get support for it to increase the chances of acceptance. If you are on the discord server, share it in the [`#enhancement-proposals`](https://discord.gg/TA8kbQds95) channel.
44+
- **Gather Feedback**: Refine your proposal based on community input. All feedback should be added as comments on the PR so the discussion stays with the document.
45+
- **Show Support**: Agreement with the proposal should be indicated by adding a thumbs-up reaction to the PR. The more support a proposal has, the more likely it is to be accepted.
4646
- **Iterate**: Make changes to the proposal based on feedback.
4747
- **Agree on an Implementor**: To avoid stagnant proposals, we require someone agree to implement it. This could be the proposer.
4848
- **Ready for Review**: Once the proposal is ready for review, change the PR status to `Ready for Review`.
@@ -91,8 +91,8 @@ Once a proposal has been accepted and an implementation plan has been decided, t
9191

9292
## WEP Index
9393

94-
| WEP | Title | Status | Discussion | Implementation |
95-
|-----|-------|--------|------------|----------------|
94+
| WEP | Title | Status | Proposal | Implementation |
95+
|-----|-------|--------|----------|----------------|
9696
| [0001](proposals/0001-titlebar-buttons/proposal.md) | Customising Window Controls | Implemented | [#3508](https://github.com/wailsapp/wails/pull/3508) | [#3508](https://github.com/wailsapp/wails/pull/3508) |
9797

9898
**Statuses**: `Draft` (under discussion), `Accepted` (approved, awaiting implementation), `Implemented` (shipped), `Rejected` (declined), `Withdrawn` (closed by the author or for inactivity).

v3/wep/WEP_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
**Status**: Draft
77
**Author**: [Your Name]
88
**Created**: [YYYY-MM-DD]
9-
**Discussion**: [link to your discussion in the Enhancement Proposals category]
9+
**Discussion**: [optional link to any prior discussion of the idea]
1010
**Implementor**: [who has agreed to implement this, may be the author]
1111

1212
## Summary

v3/wep/proposals/0001-titlebar-buttons/proposal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
**Status**: Implemented
77
**Author**: Lea Anthony
88
**Created**: 2024-05-20
9-
**Discussion**: [#3508](https://github.com/wailsapp/wails/pull/3508)
9+
**Proposal**: [#3508](https://github.com/wailsapp/wails/pull/3508)
1010
**Implementor**: Lea Anthony
1111

1212
## Summary

0 commit comments

Comments
 (0)