Update bug reporting docs

This commit is contained in:
Lea Anthony 2023-11-16 08:52:00 +11:00
commit 1fed110afd
No known key found for this signature in database
GPG key ID: 33DAF7BB90A58405
2 changed files with 22 additions and 8 deletions

View file

@ -5,12 +5,19 @@ posts before creating new ones. Here are the different ways to provide feedback:
=== "Bugs"
If you find a bug, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel on Discord:
If you find a bug, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel on Discord.
- The post should clearly state what the bug is and have a simple reproducible example. If the docs are unclear what *should* happen, please include that in the post.
- The post should be given the `Bug` tag.
- Please include the output of `wails doctor` in your post.
- *Remember* unexpected behaviour isn't necessarily a bug - it might just not do what you expect it to do. Use [Suggestions](#suggestions) for this.
- If the bug is behaviour that does not align with current documentation, e.g. a window does not resize properly, please do the following:
- Update an existing example in the `v3/example` directory or create a new example in the `v3/examples` folder that clearly shows the issue.
- Open a [PR](https://github.com/wailsapp/wails/pulls) with the title `[v3 alpha test] <description of bug>`.
- Please include a link to the PR in your post.
!!! warning
*Remember*, unexpected behaviour isn't necessarily a bug - it might just not do what you expect it to do. Use [Suggestions](#suggestions) for this.
=== "Fixes"

View file

@ -5,12 +5,19 @@
=== "错误"
如果您发现错误请在Discord的[v3 Alpha Feedback](https://discord.gg/3mgVyGua)频道中发布信息:
如果您发现了一个错误请通过在Discord上发布到[v3 Alpha 反馈](https://discord.gg/3mgVyGua)频道来告知我们。
- 帖子应清楚地说明是什么错误,并提供一个简单的可复现示例。如果文档对于*应该*发生什么不清楚,请在帖子中包括这一点。
- 帖子应该被标记为`Bug`标签。
- 请在您的帖子中包括`wails doctor`的输出结果。
- 如果错误是与当前文档不一致的行为,例如窗口无法正确调整大小,请执行以下操作:
- 在`v3/example`目录中更新一个现有示例或在`v3/examples`文件夹中创建一个清楚显示问题的新示例。
- 使用标题为“[v3 alpha test] <错误描述>”的[PR](https://github.com/wailsapp/wails/pulls)打开一个请求。
- 请在您的帖子中包括指向PR的链接。
!!! warning
*记住*,异常行为不一定是错误 - 它可能只是不按照您预期的方式工作。请使用[建议](#suggestions)来反馈这类情况。
- 帖子应清楚地说明错误所在,并提供一个简单的可重现示例。如果文档不清楚应该发生什么,请在帖子中说明。
- 帖子应标记为`Bug`
- 请在帖子中包含`wails doctor`的输出。
- 请记住,意外行为不一定是错误-它可能只是不符合您的期望。请使用[建议](#suggestions)。
=== "修复"