Introduce a PR template #1055
Introduce a PR template #1055
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main-dev #1055 +/- ##
=========================================
Coverage 79.85% 79.85%
=========================================
Files 108 108
Lines 18842 18842
=========================================
Hits 15046 15046
Misses 3796 3796
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| * [ ] The pull request title is a good summary of the changes | ||
| * [ ] Documentation reflects the changes where applicable | ||
| * [ ] Unit tests for the changes exist | ||
| * [ ] Tests pass on CI and locally |
There was a problem hiding this comment.
Checklist looks good but could be even more specific:
Before making a pull request, ensure that tests pass locally. (Don't overload github-CI)
Make the PR a draft-PR (Under reviewers).
After CI passes satisfactorily, make PR ready to review (select reviewer)
There was a problem hiding this comment.
Before making a pull request, ensure that tests pass locally. (Don't overload github-CI)
Sometimes we open draft PRs well before any intention of merging. Draft PRs are really designed to be opened as soon as one has an idea. So while I agree testing locally should be done in conjunction with opening a PR, I don't see a reason to not open a draft PR if you expect tests to fail on CI.
Make the PR a draft-PR (Under reviewers).
After CI passes satisfactorily, make PR ready to review (select reviewer)
👍 I will write something to this effect.
|
@heikoklein we went through this at the meeting today and agreed on some changes and language |
Similar to the issue templates, a PR template could benefit the project.