put the actual description first in issue templates #35295
Conversation
...so that relevant information appears when hovering over items of the issue list, and so that one can read the actual issue on the issue page without scrolling over a full page of boilerplate. Also remove the title from the Description section of the PR template (same rationale).
...that don't make sense with their particular PR
|
Thanks for your comment! |
There was a problem hiding this comment.
From a dev point of view that mainly reads issues, this seems like a good and helpful change. The rationale for the checklist-first approach is that it serves as a guideline for people creating issues. If the checklist is at the end, there is a high chance that it is simply ignored (are you going to really search for similar issues if you already spent 5 mins writing the main issue body?)
Not sure what is more important...
|
Thanks for your comments.
I agree that this is a risk, but we can always go back to the old version if this proves an issue in practice. As a middle ground, we could also leave the instructions (“Please search to see if an issue already exists for the bug you encountered.”, etc.) at the beginning while moving the checklist itself to the end. As an aside, I don't really like the fact that many fields, including the checklist items, are mandatory. My experience with forms is that there are always cases where you really have a good reason not to fill a given field but the computer doesn't let you... |
That sounds like a really nice solution, indeed! |
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## develop #35295 +/- ##
===========================================
- Coverage 88.62% 88.61% -0.02%
===========================================
Files 2148 2148
Lines 398653 398653
===========================================
- Hits 353308 353264 -44
- Misses 45345 45389 +44 see 23 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
mezzarobba
force-pushed
the
issue_template
branch
from
f181c09
to
c00ce3c
Compare
...while keeping the checklist at the end. With this version, I thought it made sense to apply the change to ftbfs issues too. I left the "Environment" section near the beginning in that case, though it makes for a small inconsistency wrt the bug report template.
mezzarobba
force-pushed
the
issue_template
branch
from
c00ce3c
to
d6d7630
Compare
|
I have implemented the solution discussed with Tobias and removed the draft flag. Formal review welcome! |
|
Thank you! |
|
Merge conflict |
|
Documentation preview for this PR (built with commit f2a3896; changes) is ready! 🎉 |
|
@mkoeppe, I'm not sure why you added the needs_work label after Dima fixed the merge conflict. I reverted the ticket to positive review, but feel free to change it again if there was indeed something to fix. |
|
I don't remember; probably I just didn't notice that Dima had already fixed the conflict, or it happened simultaneously. |
...so that relevant information appears when hovering over items of the
issue list, and so that one can read the actual issue on the issue page
without scrolling over a full page of boilerplate.
Also remove the title from the Description section of the PR template
(same rationale).
Any opinions on that?
📚 Description
📝 Checklist
⌛ Dependencies