Adjust "Report a bug" wording on Gitea issue template #122166

Merged
Brecht Van Lommel merged 2 commits from Alaska/blender:update-issue-template into main 2024-05-27 13:00:27 +02:00
Member

Adjust the wording of the "Report a bug" section of the Gitea
issue template to make it easier for people to find the button,
and add a node about using "Report a bug" to the issue description.

Adjust the wording of the "Report a bug" section of the Gitea issue template to make it easier for people to find the button, and add a node about using "Report a bug" to the issue description.
Alaska added 1 commit 2024-05-23 17:04:55 +02:00
Author
Member

There is a on-going project (Overall task, Issue template design task) for the triaging module to try and improve the bug reporting process to hopefully get higher quality bug reports. There is still some disagreements about larger changes, and so the project keeps seeing delays. Also, I'm just a volunteer and I'm working on this in my spare time.

But small changes like this pull request can be helpful right now and should hopefully not have polarizing views while we sort out the larger changes.


I'm sorry, I'm not sure who best to add as a reviewer, so I added many of the people that previously made adjustments to the issue templates. Please let me know if you don't want to be added as a reviewer for future changes, or if I should add different people.


Do I also need to update the issue template in the add-ons repository?

There is a on-going project ([Overall task](https://projects.blender.org/infrastructure/blender-projects-platform/issues/78), [Issue template design task](https://projects.blender.org/blender/blender/issues/121260)) for the triaging module to try and improve the bug reporting process to hopefully get higher quality bug reports. There is still some disagreements about larger changes, and so the project keeps seeing delays. Also, I'm just a volunteer and I'm working on this in my spare time. But small changes like this pull request can be helpful right now and should hopefully not have polarizing views while we sort out the larger changes. --- I'm sorry, I'm not sure who best to add as a reviewer, so I added many of the people that previously made adjustments to the issue templates. Please let me know if you don't want to be added as a reviewer for future changes, or if I should add different people. --- Do I also need to update the issue template in the add-ons repository?
Alaska requested review from Philipp Oeser 2024-05-23 17:11:21 +02:00
Alaska requested review from Brecht Van Lommel 2024-05-23 17:11:28 +02:00
Alaska requested review from Sergey Sharybin 2024-05-23 17:11:35 +02:00
Alaska requested review from Thomas Dinges 2024-05-23 17:11:45 +02:00
Iliya Katushenock added this to the Triaging project 2024-05-23 17:12:26 +02:00
Alaska added the
Module
Triaging
label 2024-05-23 17:14:20 +02:00

To be honest, I am not really sure what issue this change addresses, and find the wording a bit strange. Are there a lot of people who can not find the Help menu in Blender?

The wording like "Use 'Help > Report a bug' from the Blender's main menu to automatically fill out part of this form" would read less strange to me.

To be honest, I am not really sure what issue this change addresses, and find the wording a bit strange. Are there a lot of people who can not find the Help menu in Blender? The wording like "Use 'Help > Report a bug' from the Blender's main menu to automatically fill out part of this form" would read less strange to me.

Do I also need to update the issue template in the add-ons repository?

Addons are moved to the extensions platform. The addons which are hosted on our servers (https://projects.blender.org/extensions/) have their own issue trackers.

So, i wouldn't worry about addons issue template.

> Do I also need to update the issue template in the add-ons repository? Addons are moved to the extensions platform. The addons which are hosted on our servers (https://projects.blender.org/extensions/) have their own issue trackers. So, i wouldn't worry about addons issue template.
Author
Member

Are there a lot of people who can not find the Help menu in Blender?

There are a few bugs reports from people that don't use Help > Report a bug. I don't know for sure why these people aren't using Help > Report a bug, but I can think of two main reasons:

  • Blender isn't opening (This needs to be addressed another way)
  • This is their first time reporting a bug and they don't know about Help > Report a bug, so they go to their favourite search engine and search for "Blender bug report". And they're directed to projects.blender.org and go through the process to create a new bug report directly from the website.
    • Changing the about field to remind people to use Help > Report a bug should help in this case as they are told to use this button before they even get to the bug report form.

Once a user gets to the bug reporting form they are told to use Help > Report a bug, and yet some people still aren't using it. My two main guesses for why are:

  • People can't find the Help button. (I think it's unlikely, but possible)
  • People just skip the "Instructions" section at the top of the bug reporting form (This pull request doesn't fix that)

"Use 'Help > Report a bug' from the Blender's main menu..." would read less strange to me.

The main issue I have is that people may be confused about what the main menu is. If someone told me to check the main menu of Blender, my first thought is the splash screen.

> Are there a lot of people who can not find the Help menu in Blender? There are a few bugs reports from people that don't use `Help > Report a bug`. I don't know for sure why these people aren't using `Help > Report a bug`, but I can think of two main reasons: - Blender isn't opening (This needs to be addressed another way) - This is their first time reporting a bug and they don't know about `Help > Report a bug`, so they go to their favourite search engine and search for "Blender bug report". And they're directed to `projects.blender.org` and go through the process to create a new bug report directly from the website. - Changing the `about` field to remind people to use `Help > Report a bug` should help in this case as they are told to use this button before they even get to the bug report form. Once a user gets to the bug reporting form they are told to use `Help > Report a bug`, and yet some people still aren't using it. My two main guesses for why are: - People can't find the Help button. (I think it's unlikely, but possible) - People just skip the "Instructions" section at the top of the bug reporting form (This pull request doesn't fix that) --- > "Use 'Help > Report a bug' from the Blender's main menu..." would read less strange to me. The main issue I have is that people may be confused about what the main menu is. If someone told me to check the main menu of Blender, my first thought is the splash screen.
Philipp Oeser approved these changes 2024-05-24 11:06:30 +02:00
Philipp Oeser left a comment
Member

think this is an improvement (no strong opinion about "top of" vs. "main menu" vs. "top bar"), so +1 from me

think this is an improvement (no strong opinion about "top of" vs. "main menu" vs. "top bar"), so +1 from me
Brecht Van Lommel reviewed 2024-05-24 17:08:01 +02:00
Brecht Van Lommel left a comment
Owner

I think it's just people who don't read the instructions. But I don't care much about the wording either way. If the triaging team is happy with the changes go ahead.

I think it's just people who don't read the instructions. But I don't care much about the wording either way. If the triaging team is happy with the changes go ahead.
@ -1,5 +1,5 @@
name: Bug Report
about: File a bug report
about: Use 'Help > Report a bug' from the top of Blender to automatically fill out part of this form.

Report a bug -> Report a Bug

Also the convention in Blender docs is to not use quotes for this.

Report a bug -> Report a Bug Also the convention in Blender docs is to not use quotes for this.
Author
Member

Also the convention in Blender docs is to not use quotes for this.

I have removed the quotes. Ideally we would make it bold like it is in the instructions section, but the about field doesn't support markdown.

> Also the convention in Blender docs is to not use quotes for this. I have removed the quotes. Ideally we would make it bold like it is in the instructions section, but the about field doesn't support markdown.
Alaska added 1 commit 2024-05-25 05:17:19 +02:00
Brecht Van Lommel approved these changes 2024-05-27 10:45:06 +02:00
Sergey Sharybin approved these changes 2024-05-27 10:55:06 +02:00
Sergey Sharybin left a comment
Owner

I would still personally use different wording, but ultimately it is the triaging people who are in charge to make those decisions.

Just to not being the blocking reviewer, here is the greenie :)

I would still personally use different wording, but ultimately it is the triaging people who are in charge to make those decisions. Just to not being the blocking reviewer, here is the greenie :)
Brecht Van Lommel merged commit 9bbc12559f into main 2024-05-27 13:00:27 +02:00
Brecht Van Lommel deleted branch update-issue-template 2024-05-27 13:00:30 +02:00
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#122166
No description provided.