clarify prompts #1
Conversation
| @@ -1,4 +1,4 @@ | |||
| #### What does this PR do? | |||
| #### What changes are we making? Why are we making them? | |||
There was a problem hiding this comment.
From the peanut gallery: "What changes are we making? What problem do these changes solve? Why solve the problem this way?"
There was a problem hiding this comment.
i would actually love to have a separate section for each of these questions/prompts because it provides a framework for replying.
how about something like this? (slightly reworded)
What problem does this PR solve?
...
What changes are we making?
...
Why solve the problem this way?
...
perhaps there's a kinder way to ask about the rationale than Why solve the problem this way? — it comes across very confrontational, or at least that's how i read it. 😆
There was a problem hiding this comment.
maybe: What changes are we making? →
How are we solving the problem? (Explain the changes.)
...
that gives us a natural what → how → why progression
There was a problem hiding this comment.
I think "What changes are we making?" could be taken too literally.
"What technical or business problems does this PR solve?" might be all that's needed IMO. That too me is the crux of what this section is asking.
There was a problem hiding this comment.
how about:
What technical/business problem(s) are we solving?
...
How are we solving it? (Explain the changes and the rationale)
...
Thinking about how to be more direct w/r/t our prompts. Comments/discussion encouraged.