From 6cd5edcc4de394b37b88293463d4ac58596308de Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Fri, 25 Nov 2022 14:50:05 +1100 Subject: [PATCH] More clarity around bug reports --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++++ website/src/pages/community-guide.mdx | 1 + 2 files changed, 5 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 238453d3b..180057d45 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -14,6 +14,10 @@ body: - Search the issue tracker using [this link](https://github.com/wailsapp/wails/issues?q=is%3Aissue+). - Search the [discussion forums](https://github.com/wailsapp/wails/discussions?discussions_q=type+your+issue+here). - Read the [Troubleshooting Guide](https://wails.io/docs/next/guides/troubleshooting). + - Create a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) and link to it in the issue. + - If your issue is related to TypeScript generation, please open a ticket and create a PR with a failing test case. + 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. - Try to fix it yourself. Keep a list of things you have done to fix the problem. If after doing all the above, the problem remains, please continue with this ticket providing *all* the information requested. diff --git a/website/src/pages/community-guide.mdx b/website/src/pages/community-guide.mdx index 9f8e3b3a8..895b52b1d 100644 --- a/website/src/pages/community-guide.mdx +++ b/website/src/pages/community-guide.mdx @@ -82,6 +82,7 @@ The process for fixing bugs are as follows: - The steps to reproduce. Sometimes bugs are opened that are not Wails issues and the onus is on the reporter to prove that it is a Wails issue with a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) - The output of `wails doctor` +- A test that can reproduce the bug - If the ticket does not include this information, feel free to request the information from the person who opened the ticket. - Comment on the ticket stating you wish to develop a fix