Skip to content
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

Issue template: move reproduction steps to the top #34279

Merged
merged 1 commit into from Sep 14, 2022
Merged

Conversation

Janpot
Copy link
Member

@Janpot Janpot commented Sep 11, 2022

Following up on mui/mui-toolpad#908 which proposes to experiment with this in the core repo first.

When creating issues an issue I tend to

  1. describe the steps that lead me to the situation
  2. explain what's buggy about it
  3. explain what the correct behavior may be

in that order. However, the issue template puts 1. after 3. Whenever I file a core bug report, it feels like the issue template works against me.

@Janpot Janpot added the core Infrastructure work going on behind the scenes label Sep 11, 2022
@mui-bot
Copy link

mui-bot commented Sep 11, 2022

No bundle size changes

Generated by 🚫 dangerJS against 0ffbb92

@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 11, 2022

To further precise the pain point, I think that it's a matter of: who we optimize for:

  • The current issue template feels optimized for maintainers. You first want to see what's wrong/expected, to get some intuition on what the issue is about. It's only then that you will look at the reproduction in case you have a doubt.
  • However, as a developer, when you create an issue, it feels backward. I don't know about you, but when I create an issue, I have to force myself to move content out of the actual behavior to the reproduction steps.

No objections to trying this change.

@michaldudak
Copy link
Member

I guess it depends on the person. I prefer to explain what's wrong first, then describe how to get there. I'm ok with trying another approach, though.

@Janpot Janpot merged commit 7ab525c into mui:master Sep 14, 2022
@Janpot Janpot deleted the repro branch September 14, 2022 13:20
@oliviertassinari
Copy link
Member

@michaldudak How do this experimentation go over the last few weeks?

@michaldudak
Copy link
Member

Both approaches are equally fine for me, so we can choose the one that suits the rest of the team better.

@oliviertassinari
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants