Bug template: Move reproduction above current behavior #908
Conversation
|
Your Render PR Server URL is https://toolpad-pr-908.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-ccbkjknho1kli2o880s0. |
oliviertassinari
requested a deployment
to
bug-template - toolpad-db PR #908
Render
Abandoned
|
not sure, maybe it makes sense to first explain the issue in general and then provide the reproduction as it can be more specific |
|
This PR makes me think of mui/mui-design-kits#73 (comment) |
|
One pain point I have with the current bug template is the duplication of the effort between "Actual behavior" and "Reproduction". Most of the time, I almost give the full reproduction on the "Actual behavior" step. It seems to be close to the pain point raised by @Janpot
So I think that it could make sense to ask for the reproduction directly inside the "Actual behavior", or just after. I would only be careful with the change not reducing the compliance rate of the developers with the instructions. Otherwise, I personally think that this is a change that should be first experimented with http://github.com/mui/material-ui as we will learn faster about whether it's better or worse. |
👍 opening mui/material-ui#34279 |
|
I suspect that we could move forward with this change 👍 |
|
Your Render PR Server URL is https://toolpad-pr-908.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-cd807thgp3jut4np0js0. |
Doesn't this logically belong before "current behavior"? I mean, how can I explain the current behavior without first explaining how to produce the behavior?
I repeatedly find myself explaining the problem in "current behavior" and then arriving at "reproduction steps" and realizing I already gave them in the earlier section.