Skip to content

clarify prompts #1

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.

Sign up for GitHub

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

Open
blech75 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

clarify prompts #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#### What does this PR do?
#### What changes are we making? Why are we making them?

@elainemacurdy elainemacurdy Dec 1, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the peanut gallery: "What changes are we making? What problem do these changes solve? Why solve the problem this way?"

@blech75 blech75 Dec 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 😆

@blech75 blech75 Dec 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe: What changes are we making? →

How are we solving the problem? (Explain the changes.)

...

that gives us a natural what → how → why progression

@andrewb andrewb Dec 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@blech75 blech75 Dec 1, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about:

What technical/business problem(s) are we solving?

...

How are we solving it? (Explain the changes and the rationale)

...


[_Required_](https://apartmenttherapy.slite.com/app/channels/R54jSBx0aG/notes/88ULglsAB9#be26d1ca)

Expand Down