Prefill GitHub Issue Template automatically #927
Merged
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
|
Note: It can't be tested until we merge the changes in the template to main (because we need attribute ids), but I can confirm that it works (I created a test repo for this purpose and made sure that the labels and project are correctly assigned). |
exigow
changed the title
|
Note: I couldn't find a way to get a string similar to the Help->About->Copy and Close option (in reasonable time, I still believe it's accessible somewhere in API). |
Related to #645 This PR modifies the way users can report bugs from within the IDE. Instead of creating a new "blank" issue, we now use a template for bug reporting. This gives us several cool features. This PR addresses few problems: * From now on, users cannot smash the "Open GitHub Issue" button because an additional input are required: description and steps to repro. This will increase the quality of our reports. * Bugs reported manually and automatically now have an identical structure. Additional notes: * I simplified the template because some text was redundant/noise. * I removed the tests because the way we generate Markdown is now tightly coupled with logic/encoding. * It's not easy to programmatically check if modifications to the template are breaking automatic reporting. For this purpose, I simply added a comment against modification with instructions on what to pay attention to. Test Plan * Invoke error (eg place error("") somewhere in code) * Use Open GitHub Issue * Verify: Browser is opened using "JetBrains Bug report" template * Verify: Two labels are assigned: "label" and "team/jetbrains" * Verify: Project "sourcegraph/381" is assigned
pkukielka
approved these changes
Mar 1, 2024
|
We need to merge this into the main first to be able to check if the reporting works. I am merging now and will let you know soon if it's OK. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related to #645
This PR modifies the way users can report bugs from within the IDE. Instead of creating a new, prefilled but default issue, we now use a
report_bug.yamltemplate. This gives us several cool features.From now on, users cannot smash the "Open GitHub Issue" button because an additional input are required: description and steps to repro. This will increase the quality of our reports.
Bugs reported manually and automatically now have an identical structure.
Additional notes:
Test Plan