-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Tweak bug report template #44409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tweak bug report template #44409
Conversation
790f4bc
to
65f0c90
Compare
<!-- ⚠️ This is the most important part of the report ⚠️ | ||
Without a way to easily reproduce your issue, there is little chance we will be able to help you and work on a fix. | ||
Please, take the time to show us some code and/or config that is needed for others to reproduce the problem. | ||
If it's a complex bug, create a "bug reproducer" as explained in: |
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.
Maybe we should suggest to create a bug reproducer by default? I often see people posting code fragments which would be enough to reproduce something, but still requires someone to try it out to copy and paste these snippets into an application. That's something that takes time and we could make it more clear IMO that making it as easy as possible to reproduce an issue increases the likelihood for someone to look into it.
Though I have no idea how to phrase that in a short way.
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.
@xabbuh I've tweaked the text, how does that sound to you?
Maybe we can turn this into an issue form rather than a markdown template, which allows us to put more visible help texts on each field (and mark some as required), instead of having HTML comments in the markdown. |
65f0c90
to
cf48023
Compare
@stof Done, not sure if we need to keep both the md and the yaml files. |
cf48023
to
dd24a9e
Compare
@fabpot no. GitHub will ignore the md file if it has a yaml template for the same name |
shouldn't this be done in the 4.4 branch ? IIRC, we have managed those templates in the oldest maintained branch and merged them up until now (including the recent change done by @nicolas-grekas) |
dd24a9e
to
a7c7712
Compare
Rebased on 4.4, where the md files do not exist. |
FYI, I've resync all Github issue templates from 4.4 to 6.1 so that in the future, we can always merge in the lowest maintained branch like for translations (even if Github will only always use the main branch version). |
Let's make it clear that without a way to reproduce a bug, there is little chance we will be able to help or fix.
/cc @xabbuh as you are doing that manually a lot, let's try to fix the root cause ;)