This repository has been archived by the owner on Aug 7, 2024. It is now read-only.
feat: New 'Steps to Reproduce' section in bug template #9789
Conversation
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
github-actions
bot
added
issue linked
eddiejaoude
reviewed
Nov 15, 2023
Removed unnecessary code comments in the issue template per feedback. Also improved the description in the Steps to Reproduce section for more clarity.
|
I believe the documentation needs to be updated. If so, can you help me identify where it needs to be updated and what information needs to be added? |
eddiejaoude
reviewed
Nov 17, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes Issue
Closes #9742
Changes proposed
To add a required "Steps to Reproduce" section in the bug issue template to reduce the workload for maintainers and help them to reproduce bugs more quickly and easily, which will lead to faster fixes.
In
bug.ymltemplate:Steps to ReproducepropertyCheck List (Check all the applicable boxes)
Screenshots
YML Github Preview (not from actual user issue creation)
Note to reviewers
I added instruction in comment line of textarea field instead of placeholder. So that, contributor can copy the sample template and provide the steps. In case of placeholder, they need to manually type and it usually disappear when we type something in Textarea.
Please let me know if you have any feedback on whether to use a placeholder or a value for the instructions in comment line.