chore(process): add structure guide for PRs#62719
Conversation
| --> | ||
|
|
||
| Fixes TODO | ||
| Before TODO |
There was a problem hiding this comment.
The fixes TODO is an easy enough prompt to complete. But Before and After I don't immediately know what I would put there. Sure describe what is was before, and what it was after - but I got that after pondering a bit about what one would write there, which leads me to think; should we use different prompts?
There was a problem hiding this comment.
Maybe I am alone in this - but we already have a lot of filler text to delete so that all the markdown comments do not end up in the commit. Should we rather just have a link at the top with How to write a good PR - see https://www.notion.so/.......
There was a problem hiding this comment.
We need to keep these instructions short, I think we could cover examples in the linked Notion how-to.
There was a problem hiding this comment.
It's in a comment, why would you want to delete it? I personally never do so. I see your point though, but we all know that the path of least resistance will be taken in most cases, so it'll be super easy to not click on that link and just do as usual.
| --> | ||
|
|
||
| Fixes TODO | ||
| Before TODO |
There was a problem hiding this comment.
I am worried people will stick too rigorously to this template. This structure isn't ideal for all PRs. I would prefer to describe this structure as a comment. I also prefer "Previously" and "Now" over Before/After. It's more important that we increase the quality of code reviews, and push back more actively when people use bad descriptions.
There was a problem hiding this comment.
Good point, will update in a minute.
Provides guidance to cover the basics with pull request descriptions.
Before there wasn't any and the quality would vary a ton between authors. Now, with that in place, it's a visible reminder to cover the basics and mitigate the blank page syndrome.
I created a how-to in Notion, blank for now that we can use to provide additional context.
Test plan
CI