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
Modify GitHub issue and PR templates #702
Modify GitHub issue and PR templates #702
Conversation
This follows changes from numba/numba@8e308f8#diff-faa36bc26a21ed93c8de974753b71507 originally made by @stuartarchibald, whom I would like to thank here - I was not previously aware that GitHub lets you do this kind of thing. I borrowed some parts, as they were particularly well formulated.
Codecov Report
@@ Coverage Diff @@
## master #702 +/- ##
==========================================
+ Coverage 95.03% 95.04% +<.01%
==========================================
Files 58 57 -1
Lines 4697 4704 +7
==========================================
+ Hits 4464 4471 +7
Misses 233 233 Continue to review full report at Codecov.
|
Glad to be of use :) |
Nudge nudge, wink wink.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! I have a few minor suggestions but otherwise it looks pretty good. Making these templates shorter will be really helpful especially since it's so common to skip through long blocks of text. Thank you!
Please make sure tests are passing before requesting a review - they | ||
will pop up at the bottom, in the Checks box. If you're unsure why | ||
they're failing, ask! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reminds me that we should change the code coverage test threshold so that a drop in coverage of less than perhaps 0.05% still passes, or maybe that the changed lines need to be >95% tested, or something like that. I'd need to look up how to do this with Azure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this would be a codecov thing!
.github/PULL_REQUEST_TEMPLATE.md
Outdated
* If your pull request is not yet ready for review, add a `[WIP]` | ||
label to its name and remove it once it's ready. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We haven't been doing this step lately, so I'd be in favor of removing it so that there are fewer steps. Plus, there now seems to be a "draft" feature for PRs in GitHub, though that's another thing I still need to learn how to do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, let's cut it!
Co-Authored-By: Nick Murphy <namurphy@cfa.harvard.edu>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, missed one thing. Otherwise, looks ready to go!
Co-Authored-By: Nick Murphy <namurphy@cfa.harvard.edu>
All right, thanks @namurphy! :) |
This PR modifies the existing PR template to make it less wall-of-texty
and creates two buttons in the GitHub issue interface to let people
use separate templates for bug reports and feature requests.
It also comments out the existing template, so people still see it, but it
doesn't get posted in each PR.
This follows changes from
numba/numba@8e308f8#diff-faa36bc26a21ed93c8de974753b71507
originally made by @stuartarchibald, whom I would like to thank here -
I was not previously aware that GitHub lets you do this kind of thing.
I borrowed some parts, as they were particularly well formulated.