chore: update pull_request_template #3033
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TBonnin
commented
Nov 21, 2024
.github/pull_request_template.md
Outdated
| - [ ] I have tested those changes | ||
| - [ ] I have added tests (skip if just adding/editing providers) | ||
|
|
||
| <!-- Testing instructions (if applicable) --> |
There was a problem hiding this comment.
arguably we could get rid of this one but @nalanj raised a good point where we often make the assumption that the reviewers have all the context to tests the PR.
bodinsamuel
approved these changes
Nov 21, 2024
| ## Checklist before requesting a review (skip if just adding/editing APIs & templates) | ||
| - [ ] I added tests, otherwise the reason is: | ||
| - [ ] I added observability, otherwise the reason is: | ||
| - [ ] I added analytics, otherwise the reason is: |
There was a problem hiding this comment.
lgtm, usually I go simpler. Checkboxes are annoying and honestly, after a while, you stop caring.
# 🤓 Context
# 🧪 How to tests?There was a problem hiding this comment.
I would go for that if it was a private repo but since it is public I would be slightly more verbose
nalanj
approved these changes
Nov 21, 2024
hassan254-prog
approved these changes
Nov 21, 2024
|
nobody likes checkboxes apparently so let's get rid of them: 9a62043 |
TBonnin
force-pushed
the
tbonnin/nov21/pr-template
branch
from
9a62043 to
e239147
Compare
TBonnin
force-pushed
the
tbonnin/nov21/pr-template
branch
from
e239147 to
cc88e8a
Compare
My take: having a checklist of things that rarely applies is pretty useless. I (and I am sure not the only one) just ignore the observability and analytics points. I propose this change to focus on the things that matter: description of the change, testing and ticket All of them almost always applies. Also changing to comments so the template instructions don't show once the PR is submitted
TBonnin
force-pushed
the
tbonnin/nov21/pr-template
branch
from
cc88e8a to
b627882
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
My take: having a checklist of things that rarely apply is pretty useless. I (and I am sure not the only one) just always ignore the observability and analytics points. I propose this change to focus on the things that matter: description of the changes, testing and ticket. All of them almost always applies.
Also changing to comments so the template instructions don't show once the PR is submitted
Checklist before requesting a review (skip if just adding/editing APIs & templates)