Skip to content

add "and why" to first heading/question - #2

Open
blech75 wants to merge 1 commit into
masterfrom
justinb/add-why
Open

add "and why" to first heading/question#2
blech75 wants to merge 1 commit into
masterfrom
justinb/add-why

Conversation

@blech75

@blech75 blech75 commented Mar 25, 2026

Copy link
Copy Markdown
Member

What does this PR do?

I propose adding "[...] and why?" to "What does this PR do?", an admittedly subtle change, but (imo) important nonetheless.

I suggest this change because we tend to forget to add context around "why" we're adding a change, and I hope this might help to remind us.

I've preemptively updated the associated slite doc, PR Best Practices to refelct this change, and will keep that in sync with any further changes here.

How can this change be manually tested?

n/a

Asana Card

n/a

Questions or concerns about this change?

  • Should "why" be a separate heading altogether? I feel like "and why" might get lost because people won't notice it.

Deployment Notes

n/a


PR Readiness

  • Changes have been validated in local dev

Code Readiness

Automated Testing

  • Unit tests are written at the appropriate level given the code’s risk-level
  • Existing tests still pass
  • No unnecessary test runner output, e.g. debugging or warnings are not present in Jest or Unittest output

Other Considerations

  • Relevant documentation updated in Slite

Also consider this PR's impact on architecture and security; AMP, Apple News, RSS; SEO, GA, performance and accessibility.

Please see Post Merge for additional responsibilities after this PR is merged.

@stephensauceda

stephensauceda commented Mar 25, 2026

Copy link
Copy Markdown
Member

My only concern is double-duty. The "why" should probably be answered in the Asana card that we should already be linking to. Of course, that depends on the context the "why" is being asked. The card should/would give the business "why". If we're talking about the "why" as in "why did you do it this way" that's a different story.

@blech75

blech75 commented Mar 25, 2026

Copy link
Copy Markdown
Member Author

My only concern is double-duty. The "why" should probably be answered in the Asana card that we should already be linking to. Of course, that depends on the context the "why" is being asked. The card should/would give the business "why". If we're talking about the "why" as in "why did you do it this way" that's a different story.

Fair points; I understand "and why?" is ambiguous right now.

My intent with this change is to prompt the PR author to add a concise one- or two-line explanation that provides some context to orient others when reading PRs. I'm not looking to replicate what's in the Asana card; I'm looking for a summary. (Perhaps that's a good reason for it to be a separate question.)

IMO, the PR should 'stand alone'; PR reviewers should not have to look elsewhere to orient themselves. (Imagine, if you will, that Asana was unavailable and all we had was an opaque URL.) Also note that the Asana card can be a bit overwhelming, have lots of comments, and might not be up-to-date re: approach.

Regardless, I need to think about what some good examples are here. I've seen PRs that just have the "what" without any context, which I find to be very disorienting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants