Skip to content

Commit 7d90315

Browse files
chore(.github): accept v3 bug reports, add triage dropdowns, wire up auto-labelers (#5754)
* chore(.github): accept v3 bug reports, add triage dropdowns, refresh templates - bug_report.yml: remove the 'no v3 bug reports' banner (v3 bug reports are accepted), add required 'Wails version family' (v3/v2) and 'Operating System' dropdowns, ask for wails3 doctor output (wails doctor for v2), fix v2-era links and mark the v2 binding tests reference as v2-specific alongside the v3 generator path - feature_request.yml: replace the stale Wails v1 notice with the discussion-first note (Discord / GitHub Discussions), matching CONTRIBUTING.md - documentation.yml: point the contribution guidelines link at https://v3.wails.io/contributing/ - config.yml: disable blank issues, align the Discord invite with CONTRIBUTING.md - file-labeler.yml: convert to the actions/labeler v5 configuration format - delete legacy Probot .github/stale.yml (superseded by workflows/stale-issues.yml using actions/stale@v9) - add CODE_OF_CONDUCT.md (Contributor Covenant v2.1) * ci: wire up issue and PR auto-labelers Consumes the previously orphaned .github/issue-labeler.yml (github/issue-labeler@v3.4, non-versioned regex format) and .github/file-labeler.yml (actions/labeler@v5) configs. * docs: point enhancement guidance at the WEP process The Wails Enhancement Proposal process (v3/wep) was not referenced anywhere contributors actually look. Reference it from the feature request template, CONTRIBUTING.md and the v3 docs site (contributing page gets a step-by-step summary, feedback page a pointer). Also fixes the stale feedback-guide link in CONTRIBUTING.md (/getting-started/feedback/ -> /feedback/). * chore: align Code of Conduct contact with the published site CoC The v2 website has published a Contributor Covenant CoC at wails.io/coc with coc@wails.io as the enforcement contact; use the same address in the repo-level file. * docs: make GitHub Discussions the official venue for WEP discussion Proposals are discussed in the Enhancement Proposals category on GitHub Discussions. Discord remains available for informal chat but is no longer the primary venue. Adds an explicit discuss-first step to the WEP README's Idea Initiation section. * 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) * 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. --------- Co-authored-by: taliesin-ai <lea.anthony@gmail.com>
1 parent f9cb2fc commit 7d90315

14 files changed

Lines changed: 320 additions & 89 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,46 @@ body:
77
- type: markdown
88
attributes:
99
value: |
10-
***Please note: No bug reports are currently being accepted for Wails v3***
11-
***Please note: No bug reports are currently being accepted for Wails v3***
12-
***Please note: No bug reports are currently being accepted for Wails v3***
1310
Before submitting this issue, please do the following:
1411
- Do a web search for your error. This usually leads to a much better understanding of the issue.
15-
- Prove that the error is indeed a Wails bug and not an application bug, with a specific set of steps to reproduce.
12+
- Prove that the error is indeed a Wails bug and not an application bug, with a specific set of steps to reproduce.
1613
- Search the issue tracker using [this link](https://github.com/wailsapp/wails/issues?q=is%3Aissue+).
1714
- Search the [discussion forums](https://github.com/wailsapp/wails/discussions?discussions_q=type+your+issue+here).
18-
- Read the [Troubleshooting Guide](https://wails.io/docs/next/guides/troubleshooting).
15+
- For v3, check the [FAQ](https://v3.wails.io/faq/) and the [feedback guide](https://v3.wails.io/feedback/). For v2, read the [Troubleshooting Guide](https://wails.io/docs/guides/troubleshooting).
1916
- Create a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) and link to it in the issue.
20-
- If your issue is related to TypeScript generation, please open a ticket and create a PR with a failing test case.
21-
TS tests can be found [here](https://github.com/wailsapp/wails/tree/master/v2/internal/binding/binding_test). Remember to add
22-
your test to the `binding_test.go` file.
23-
- Try to fix it yourself. Keep a list of things you have done to fix the problem.
17+
- If your issue is related to the bindings or TypeScript generation, please open a ticket and create a PR with a failing test case.
18+
For v3, the binding generator tests live [here](https://github.com/wailsapp/wails/tree/master/v3/internal/generator).
19+
For v2 only, TS tests can be found [here](https://github.com/wailsapp/wails/tree/master/v2/internal/binding/binding_test). Remember to add your test to the `binding_test.go` file.
20+
- Try to fix it yourself. Keep a list of things you have done to fix the problem.
2421
2522
If after doing all the above, the problem remains, please continue with this ticket providing *all* the information requested.
2623
2724
Bug reports that do not follow these steps will likely be closed, so please help us to help you.
2825
26+
- type: dropdown
27+
id: version_family
28+
attributes:
29+
label: Wails version family
30+
description: Which major version of Wails are you using?
31+
options:
32+
- v3
33+
- v2
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: operating-system
38+
attributes:
39+
label: Operating System
40+
description: Which operating system does the bug occur on?
41+
options:
42+
- Windows
43+
- macOS
44+
- Linux
45+
- iOS (experimental)
46+
- Android (experimental)
47+
- Multiple / Other
48+
validations:
49+
required: true
2950
- type: textarea
3051
id: description
3152
attributes:
@@ -75,7 +96,7 @@ body:
7596
id: systemdetails
7697
attributes:
7798
label: System Details
78-
description: Please add the output of `wails doctor`.
99+
description: Please add the output of `wails3 doctor` (for v2 projects, use `wails doctor`).
79100
render: shell
80101
validations:
81102
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
blank_issues_enabled: true
1+
blank_issues_enabled: false
22
contact_links:
33
- name: Discord Chat
4-
url: https://discord.gg/BrRSWTaxVK
4+
url: https://discord.gg/JDdSxwjhGf
55
about: Ask questions and discuss with other Wails users in real time.
66

77
- name: GitHub Community Discussions

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ body:
2020
attributes:
2121
label: Have you read the Documentation Contribution Guidelines?
2222
options:
23-
- label: I have read the [Documentation Contribution Guidelines](https://wails.io/community-guide#ways-of-contributing).
23+
- label: I have read the [Documentation Contribution Guidelines](https://v3.wails.io/contributing/).
2424
required: true
2525

2626
- type: textarea

.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: No new feature requests are being accepted for Wails v1***
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:

.github/file-labeler.yml

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,63 @@
1-
# File path specific labels
1+
# File path specific labels (actions/labeler v5 configuration format)
22
v2-only:
3-
- 'v2/**/*'
3+
- changed-files:
4+
- any-glob-to-any-file:
5+
- 'v2/**/*'
46

57
v3-alpha:
6-
- 'v3/**/*'
8+
- changed-files:
9+
- any-glob-to-any-file:
10+
- 'v3/**/*'
711

812
windows:
9-
- '**/*_windows.go'
10-
- 'v2/internal/frontend/desktop/windows/**/*'
13+
- changed-files:
14+
- any-glob-to-any-file:
15+
- '**/*_windows.go'
16+
- 'v2/internal/frontend/desktop/windows/**/*'
1117

1218
macos:
13-
- '**/*_darwin.go'
14-
- 'v2/internal/frontend/desktop/darwin/**/*'
19+
- changed-files:
20+
- any-glob-to-any-file:
21+
- '**/*_darwin.go'
22+
- 'v2/internal/frontend/desktop/darwin/**/*'
1523

1624
linux:
17-
- '**/*_linux.go'
18-
- 'v2/internal/frontend/desktop/linux/**/*'
25+
- changed-files:
26+
- any-glob-to-any-file:
27+
- '**/*_linux.go'
28+
- 'v2/internal/frontend/desktop/linux/**/*'
1929

2030
cli:
21-
- 'v2/cmd/**/*'
22-
- 'v3/cmd/**/*'
23-
- '**/cli/**/*'
24-
- '**/commands/**/*'
25-
31+
- changed-files:
32+
- any-glob-to-any-file:
33+
- 'v2/cmd/**/*'
34+
- 'v3/cmd/**/*'
35+
- '**/cli/**/*'
36+
- '**/commands/**/*'
37+
2638
documentation:
27-
- '**/*.md'
28-
- 'docs/**/*'
29-
- 'website/**/*'
30-
- 'mkdocs-website/**/*'
39+
- changed-files:
40+
- any-glob-to-any-file:
41+
- '**/*.md'
42+
- 'docs/**/*'
43+
- 'website/**/*'
44+
- 'mkdocs-website/**/*'
3145

3246
templates:
33-
- '**/templates/**/*'
34-
- '**/template/**/*'
47+
- changed-files:
48+
- any-glob-to-any-file:
49+
- '**/templates/**/*'
50+
- '**/template/**/*'
3551

3652
runtime:
37-
- '**/runtime/**/*'
38-
- 'v2/internal/runtime/**/*'
39-
- 'v3/internal/runtime/**/*'
40-
41-
bindings:
42-
- 'v2/internal/binding/**/*'
43-
- 'v3/internal/generator/**/*'
53+
- changed-files:
54+
- any-glob-to-any-file:
55+
- '**/runtime/**/*'
56+
- 'v2/internal/runtime/**/*'
57+
- 'v3/internal/runtime/**/*'
4458

59+
bindings:
60+
- changed-files:
61+
- any-glob-to-any-file:
62+
- 'v2/internal/binding/**/*'
63+
- 'v3/internal/generator/**/*'

.github/stale.yml

Lines changed: 0 additions & 36 deletions
This file was deleted.

.github/workflows/labeler.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Auto Labeler
2+
3+
on:
4+
issues:
5+
types: [opened, edited]
6+
pull_request_target:
7+
8+
jobs:
9+
issue-labeler:
10+
name: Label issues
11+
if: github.event_name == 'issues'
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: read
15+
issues: write
16+
steps:
17+
- uses: github/issue-labeler@v3.4
18+
with:
19+
repo-token: ${{ secrets.GITHUB_TOKEN }}
20+
configuration-path: .github/issue-labeler.yml
21+
enable-versioned-regex: 0
22+
include-title: 1
23+
24+
pr-labeler:
25+
name: Label pull requests
26+
if: github.event_name == 'pull_request_target'
27+
runs-on: ubuntu-latest
28+
permissions:
29+
contents: read
30+
pull-requests: write
31+
steps:
32+
- uses: actions/labeler@v5
33+
with:
34+
repo-token: ${{ secrets.GITHUB_TOKEN }}
35+
configuration-path: .github/file-labeler.yml
36+
sync-labels: false

CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances
31+
of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
coc@wails.io.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

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** on [Discord](https://discord.gg/JDdSxwjhGf)see the [feedback guide](https://v3.wails.io/getting-started/feedback/).
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

0 commit comments

Comments
 (0)