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

Modify GitHub issue and PR templates #702

Merged
merged 5 commits into from Oct 17, 2019

Conversation

StanczakDominik
Copy link
Member

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.

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
Copy link

codecov bot commented Oct 17, 2019

Codecov Report

Merging #702 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
plasmapy/classes/sources/plasma3d.py 100% <0%> (ø) ⬆️
plasmapy/classes/sources/plasmablob.py 100% <0%> (ø) ⬆️
plasmapy/transport/braginskii.py
plasmapy/physics/quantum.py
plasmapy/transport/collisions.py
plasmapy/physics/distribution.py
plasmapy/physics/dimensionless.py
plasmapy/physics/relativity.py
plasmapy/physics/parameters.py
plasmapy/transport/__init__.py
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7e63f51...e844f36. Read the comment docs.

@stuartarchibald
Copy link

Glad to be of use :)

Nudge nudge, wink wink.
Copy link
Member

@namurphy namurphy left a 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!

.github/ISSUE_TEMPLATE/Bug_report.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
Comment on lines +14 to +16
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!
Copy link
Member

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.

Copy link
Member Author

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!

Comment on lines 18 to 19
* If your pull request is not yet ready for review, add a `[WIP]`
label to its name and remove it once it's ready.
Copy link
Member

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.

Copy link
Member Author

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!

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/Feature_request.md Outdated Show resolved Hide resolved
StanczakDominik and others added 2 commits October 17, 2019 20:59
Co-Authored-By: Nick Murphy <namurphy@cfa.harvard.edu>
Copy link
Member

@namurphy namurphy left a 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!

.github/ISSUE_TEMPLATE/Bug_report.md Outdated Show resolved Hide resolved
@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label Oct 17, 2019
Co-Authored-By: Nick Murphy <namurphy@cfa.harvard.edu>
@StanczakDominik
Copy link
Member Author

All right, thanks @namurphy! :)

@StanczakDominik StanczakDominik merged commit f7846e0 into PlasmaPy:master Oct 17, 2019
@StanczakDominik StanczakDominik deleted the FixIssueTemplates branch October 17, 2019 19:33
@rocco8773 rocco8773 moved this from Complete to In Progress | Review in Documentation Development Jul 14, 2020
@rocco8773 rocco8773 moved this from In Progress | Review to Complete in Documentation Development Jul 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants