-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create PULL_REQUEST_TEMPLATE.md based upon the GeoCAT-comp template.
- Loading branch information
1 parent
7e2e370
commit ea07c87
Showing
1 changed file
with
64 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
## PR Summary | ||
<!-- Summary goes here. Replace XXX with the number of the issue this PR will resolve. --> | ||
Closes #XXX | ||
|
||
## PR Checklist | ||
<!-- Please mark any checkboxes that do not apply to this PR as [N/A]. If an entire section doesn't | ||
apply to this PR, comment it out or delete it. --> | ||
**General** | ||
- [ ] Make an issue if one doesn't already exist | ||
- [ ] Link the issue this PR resolves by adding `closes #XXX` to the PR description where XXX is the number of the issue. | ||
- [ ] Add a brief summary of changes to `docs/release-notes.rst` in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecated | ||
- [ ] Add appropriate labels to this PR | ||
- [ ] Make your changes in a forked repository rather than directly in this repo | ||
- [ ] Open this PR as a draft if it is not ready for review | ||
- [ ] Convert this PR from a draft to a full PR before requesting reviewers | ||
- [ ] Passes `precommit`. To set up on your local, run `pre-commit install` from the top level of the repository. To manually run pre-commits, use `pre-commit run --all-files` and re-add any changed files before committing again and pushing. | ||
|
||
**Documentation** | ||
- [ ] Docstrings have been added to all new functions | ||
- [ ] Docstrings have been updated with any function changes | ||
- [ ] Internal functions have a preceding underscore (`_`) and have been added to `docs/internal_api/index.rst` | ||
- [ ] User facing functions have been added to `docs/user_api/index.rst` under their module | ||
|
||
**Examples** | ||
- [ ] Any new notebook examples added to `docs/examples/` folder | ||
- [ ] Clear all notebook cells | ||
- [ ] New notebook files added to `docs/examples.rst` toctree | ||
- [ ] New notebook files added to new entry in `docs/gallery.yml` with appropriate thumbnail photo in `docs/_static/thumbnails/` | ||
|
||
|
||
<!-- | ||
Thank you so much for your PR! To help us review your contribution, please | ||
consider the following points: | ||
- Fork this repository and open the PR from your fork. Do not directly work on | ||
the NCAR/geocat-comp repository. | ||
- The PR title should summarize the changes, for example "Create weighted pearson-r | ||
correlation coefficient function". Avoid non-descriptive titles such as "Addresses | ||
issue #229". | ||
- The summary should provide at least 1-2 sentences describing the pull request | ||
in detail (Why is this change required? What problem does it solve?) and | ||
link to any relevant issues. | ||
- The summary in `docs/release-notes.rst` should be written as " 'Summary of changes' | ||
by `FirstName LastName`_ in (:pr:`PR#`) ". For first time contributors, add your new | ||
name and GitHub link to bottom of `docs/release-notes.rst` as _`FirstName LastName` | ||
:https://github.com/username | ||
**PR Etiquette Reminders** | ||
- This PR should be listed as a draft PR until you are ready to request reviewers | ||
- After making changes in accordance with the reviews, re-request your reviewers | ||
- Do *not* mark conversations as resolved if you didn't start them | ||
- Do mark conversations as resolved *if you opened them* and are satisfied with the changes/discussion. | ||
If you need assistance with your PR, please let the GeoCAT team know by | ||
tagging us with @NCAR/geocat. We can help if reviews are unclear, the recommended changes | ||
seem overly demanding, you would like help in addressing a reviewer's comments, | ||
or if you have been waiting more than a week to hear back on your PR. | ||
--> |