Fix issue template - simplified version #6728
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,29 @@ | ||
| ### Issue request type | ||
|
|
||
| <!-- | ||
| Required | ||
| Please add only one X to one of the following types. Do not fill multiple types (split the issue otherwise) | ||
| Please note this is not a GitHub task list, indenting the boxes or changing the format to add a '.' or '*' in front | ||
| of them would change the meaning incorrectly. The only changes to be made are to add a description text under the | ||
| description heading and to add a 'x' to the correct box. | ||
|
|
||
| [X] Question | ||
| [ ] Enhancement | ||
| [ ] Bug | ||
| --> | ||
|
|
||
| [ ] Question | ||
| [ ] Enhancement | ||
| [ ] Bug | ||
|
|
||
| <!-- | ||
| Required | ||
| Add detailed description of what is being reported | ||
| Good example: https://os.mbed.com/docs/latest/reference/workflow.html | ||
| Things to consider sharing: | ||
| - What target does this relate to? | ||
| - What toolchain is being used? | ||
| - What is the SHA of Mbed OS (git log -n1 --oneline)? | ||
| - Steps to reproduce (Did you publish code or a test case that exhibits the problem) | ||
| --> | ||
| ### Description | ||
|
There was a problem hiding this comment. Nit: I would put description at the top, otherwise most people just delete the whole thing thinking it's just going to get in the way. A lot of tools, like the auto-pr-thingy, just concatenate the description smack dab on top of the template. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the PR template, Description should come first at the top ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'm actually fine as-is. Issues tend to need a lot more detail than PRs. Knowing the type of issue before the description helps frame the mindset before reading the description.
Who knows, maybe the PR template could be modified to have the type come before the description?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Open for suggestions, could also move PR type first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not really seeing an issue with the original template, or a need to align particularly. PRs and issues are different things. Maybe change some things to checkboxes for a stylistic alignment, but structually this has always seemed fine to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lot of people ignore it (either remove it or provide default values). Similar what we experienced with PR template.