templates: use a new bug template based on forms. #90335
Conversation
nashif
force-pushed
the
topic/issues/templates_bug
branch
from
32e8514 to
e5df87b
Compare
| @@ -0,0 +1,83 @@ | |||
| name: Bug Report | |||
| description: File a bug report. | |||
| title: "[Bug]: " | |||
There was a problem hiding this comment.
Bug label, Bug type, Bug title... can you drop it from the title?
| - Is this a regression? If yes, have you been able to "git bisect" it to a | ||
| specific commit? |
There was a problem hiding this comment.
Would it be too much to have this as a dropbox? Regressions are very bad it'd be nice to have this bit of information stand out a bit more, mainly hoping to get more people to bisect their bugs.
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: | | ||
| By submitting this issue, you agree to follow our | ||
| [Code of Conduct](https://github.com/zephyrproject-rtos/zephyr/blob/main/CODE_OF_CONDUCT.md). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
There was a problem hiding this comment.
Seems excessive having to check this for every single bug.
| - type: dropdown | ||
| attributes: | ||
| label: Impact | ||
| description: Impact of this bug |
There was a problem hiding this comment.
Sad to lose the freetext here, sometimes there's good information in it.
nashif
force-pushed
the
topic/issues/templates_bug
branch
from
e5df87b to
dc589eb
Compare
nashif
force-pushed
the
topic/issues/templates_bug
branch
from
dc589eb to
b3825d2
Compare
There was a problem hiding this comment.
Why isn't Additional context part of this? Quite useful if you want to add references to specs, other issues, etc.
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. |
There was a problem hiding this comment.
Will it be rendered in the browser as monospace? If so, then I think the second sentence can be removed
There was a problem hiding this comment.
yeah, the info there is to not have people adding backticks, the content will be rendered automatically.
| - type: textarea | ||
| id: env | ||
| attributes: | ||
| label: Environment | ||
| description: please complete the following information | ||
| placeholder: | | ||
| - OS: (e.g. Linux, MacOS, Windows) | ||
| - Toolchain (e.g Zephyr SDK, ...) | ||
| - Commit SHA or Version used |
There was a problem hiding this comment.
Should this be split into 3 separate areas?
OS and Tool chain could perhaps even be checkboxes with "N/A" and "Other, please specific" as options (if supported).
There was a problem hiding this comment.
IMO we will end up with way too many fields, lets see how this goes and we can split out additional fields as we go forward and if it makes sense.
Use a form based template instead of freesyle template. This will force bug reporters to follow the template and provide the needed information and will make triage easier and bug reports consistent. Signed-off-by: Anas Nashif <[email protected]>
nashif
force-pushed
the
topic/issues/templates_bug
branch
from
b3825d2 to
a51a34d
Compare
|
Use a form based template instead of freesyle template. This will force
bug reporters to follow the template and provide the needed information
and will make triage easier and bug reports consistent.
Signed-off-by: Anas Nashif [email protected]
this is how it will look like: