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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
@@ -0,0 +1,37 @@
---
name: Bug Report
about: Help us fix bugs in PlasmaPy

---

<!--

Thanks for opening an issue! To help us react appropriately to your report,
please first look through https://github.com/PlasmaPy/PlasmaPy/issues and check
whether no other issue already describes your problem.

For more general "how do I do X?" type questions, please speak to us in real
time on https://riot.im/app/#/room/#plasmapy:openastronomy.org or ask on Discourse
https://plasmapy.discourse.group

-->

## Reporting a bug

<!--

Before submitting a bug report please ensure that you can check off these boxes:

-->

- [ ] I am using the latest released version of PlasmaPy (most recent is visible in
the release notes (http://docs.plasmapy.org/en/stable/about/release_notes.html).
StanczakDominik marked this conversation as resolved.
Show resolved Hide resolved
- [ ] I have included below a minimal working reproducer (if you are unsure how
to write one see http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports).

<!--

Please include details of the bug here, including, if applicable, what you
expected to happen!

-->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
@@ -0,0 +1,26 @@
---
name: Feature Request
about: Suggest an idea for PlasmaPy

---

<!--

Thanks for opening an issue! To help us react appropriately to your report,
please first look through https://github.com/PlasmaPy/PlasmaPy/issues and check
whether no other issue already describes your problem.

For more general "how do I do X?" type questions, please speak to us in real
time on https://riot.im/app/#/room/#plasmapy:openastronomy.org or ask on Discourse
https://plasmapy.discourse.group

-->

## Feature request

<!--

Please include details of the feature you would like to see, why you would
like to see it/the use case

-->
50 changes: 35 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,23 +1,43 @@
Thank you for contributing to PlasmaPy! Please check out our development guide at:
<!--
Thank you for contributing to PlasmaPy! Here's a bunch of pointers to
make things easier for all of us:

http://docs.plasmapy.org/en/master/development/index.html

Here are a few things to keep in mind when making a pull request (PR).

* Tests and docstrings are required for new or changed functionality.
* Please take care to write helpful commit messages: https://chris.beams.io/posts/git-commit/
* As a PR nears completion, fellow developers will likely suggest changes
to be made before the PR is merged.
* Every pull request should include a changelog entry. Please see
`changelog/README.rst` for instructions.
* PlasmaPy follows the PEP 8 style guide: https://www.python.org/dev/peps/pep-0008
* Please double check that a new PR will not duplicate an existing PR.
* If this PR will solve an issue tracked by GitHub, please add a phrase like
"Closes #404." to automatically close the issue once the pull request is
merged. If your PR will not completely solve the issue, please still
reference the issue.
reference the issue. For an overview of this functionality, see
https://help.github.com/articles/closing-issues-using-keywords/

* Remember to add some description of your changes in this text box.

* Tests and docstrings are required for new or changed functionality.
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!
Comment on lines +14 to +16
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!


* If your pull request is not yet ready for review, submit it as a draft.
Remember to change its' status once it's ready.

* If this is your first contribution, please add your name to the author
list in `docs/about/credits.rst`.

* Feel free to chat with other developers on our Matrix channel at:
https://riot.im/app/#/room/#plasmapy:matrix.org
https://riot.im/app/#/room/#plasmapy:openastronomy.org

* We have a developer's guide, where some answers to your questions may
possibly be found, at
http://docs.plasmapy.org/en/master/development/index.html

Many thanks in advance for following these pointers and for being willing to contribute!

When submitting a pull request, please ensure that you can (eventually,
sometime before it is merged) check the following basic requirements:

-->

- [ ] I have added a changelog entry for this pull request (please see
`changelog/README.rst` for instructions, and if you need help with picking the PR type, ask!)
- [ ] If adding new functionality, I have added (passing) tests and
docstrings. (Tests pop up at the bottom, in the checks box).
- [ ] I have fixed any new failing tests (if you're unsure why
they're failing, ask!).