Added a feature for bug reporting #72
Conversation
There was a problem hiding this comment.
This is amazing! I didn't know about this feature of GitHub, so thank you for introducing us to it. I look forward to learning more about it with you. I've reviewed the code and left feedback on particular lines with project-specific improvements. The form is great, it includes questions for all of the things that make a good bug report, but many of our users are not programmers and so our form should do more to cater to that user base.
In general, our philosophy on bug reports is that the barrier to reporting a bug should be low, otherwise users may see the form and decide to not report a bug at all. A poor bug report is better than no bug report. Even a duplicate bug report can give us helpful information. So there are some comments about making required questions optional and some wording suggestions.
I hope it's not too much feedback! I tried to be helpful and give some suggestions where I could which is why some comments look very long. If you have any questions or think I'm wrong on something, feel free to follow up in a reply. Like I said, this is an amazing start and I really appreciate this contribution!
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! |
There was a problem hiding this comment.
More of a note to myself: we should include a warning like "This report will be public. Do not include confidential research data in this report. This information might be in file names, transcripts, and some log outputs so double check before you submit!"
There was a problem hiding this comment.
I did not change anything here. If you want, we can add this disclaimer also into the bug report.
|
I changed some things in the files. I hope it was correct, as I tried to push it again. If you can't see the changes, I will try again ;-) |
Documents.code-workspace
Outdated
| { | ||
| "folders": [ | ||
| { | ||
| "path": "../../.." | ||
| }, | ||
| { | ||
| "path": "../.." | ||
| } | ||
| ], | ||
| "settings": {} | ||
| } |
There was a problem hiding this comment.
Is this a config file from VS Code? I don't think you meant to commit this. You can add *.code-workspace to your .gitignore so that git commit -a ignores files like this.
There was a problem hiding this comment.
Thank you!
I added it to the .gitignore and pushed it again. I hope, it works now.
Sorry for the inconvenience
There was a problem hiding this comment.
No inconvenience, it's why we do code review!
I added a bug reporting form and a description of the bug triage.
I hope, that I understood the task correctly.