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

Create pull_request_template.md #430

Merged
merged 14 commits into from
Feb 22, 2024
Merged

Create pull_request_template.md #430

merged 14 commits into from
Feb 22, 2024

Conversation

matentzn
Copy link
Member

@matentzn matentzn commented Feb 5, 2024

Fixes #361.

This PR:

  • Creates a PR template which should be populated for every PR.

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
- [ ] Reviewed
- Has been sufficiently reviewed by at least one review from a different team member of the Mondo Technical team.

## Overview
Copy link
Contributor

@joeflack4 joeflack4 Feb 7, 2024

Choose a reason for hiding this comment

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

Suggested change
## Overview
## Overview
<!--- A few sentences describing changes / what problem is solved. Should describe the expected result of the changes. If applicable, point out the main change that solved the problem, e.g. fixed bug in method xyz. -->

I tried to select multiple lines to suggest replacement of multiple lines (step 4 in this guide from GitHub), but it didn't work. My suggestion here is to replace the whole "Overview" section with this one comment.

Rationale:
As I mentioned in this comment:

Our new suggested template suggests listing changes as bulleted list. But in practice, my preferences is a short paragraph (2-3 sentences). Anything more than that I usually put in an "additional information" section. And I actually have for a long time included a bulleted list of changes. However, I do this in a "Changes" or "Updates" section, and all that I do there is simply copy/paste my commit message(s).

Copy link
Contributor

Choose a reason for hiding this comment

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

The overview should be a few sentences that describes what problem is being solved with this PR. It's fine to refer back to the issue for more detailed information, but the comment in the PR should be clear enough to understand the problem.

The Overview should also point out what the major change was to solve the problem, e.g. fixed bug in method xyz or updated the make statement for goal 123.

The Overview should also point out what is the expected result of the change of the code fix, e.g. when sh run.sh make build-mondo-ingest is run on the branch what is the new behavior.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yea agreed with that @twhetzel. @joeflack4 can fold this into your suggestion above?

Copy link
Contributor

@joeflack4 joeflack4 Feb 8, 2024

Choose a reason for hiding this comment

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

The Overview should also point out what the major change was to solve the problem, e.g. fixed bug in method xyz or updated the make statement for goal 123.

I agree with that when it is applicable. Just spitballing, I think PRs have been small enough for single changes like these 25% of the time or so.

Yeah I'll go ahead and update the code suggestion there momentarily.

Copy link
Member Author

@matentzn matentzn Feb 9, 2024

Choose a reason for hiding this comment

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

Unresolving conversation which was automatically closed by github.

Action items:

  • add @twhetzel suggestions in a compressed form into the comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Alright done, feel free to commit the suggestion if you guys like it!

@twhetzel
Copy link
Contributor

I made a gist to suggest a new format to make it more clear the yes/no answers.

@matentzn
Copy link
Member Author

Super cool Trish, I like it

@joeflack4
Copy link
Contributor

Regarding the gist, I like it too. Maybe we can make a new commit here for the next evolution of this template.

The essential difference I glean is the difference of 1 checkbox per criteria, or 2+ checkboxes for options. I added a comment as well as an alternative evolution to the gist.

@twhetzel
Copy link
Contributor

Thanks for comments on the gist. I wasn't sure if this would be too long/drastic a change, but since y'all are ok with this I have committed this change and will merge.

@twhetzel twhetzel merged commit 3fbe991 into main Feb 22, 2024
@twhetzel twhetzel deleted the matentzn-patch-3 branch February 22, 2024 05:27
@joeflack4 joeflack4 mentioned this pull request Feb 22, 2024
9 tasks
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.

PR instructions update
3 participants