-
Notifications
You must be signed in to change notification settings - Fork 55
clean up github PR form template #1608
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,18 @@ | ||
| <!-- The PR title should summarize the changes, for example "Add `Grid._build_face_dimension` function". | ||
| Avoid non-descriptive titles such as "Addresses issue #229". --> | ||
|
|
||
| <!-- Replace XXX with the number of the issue that this PR will resolve. If this PR closed more than one, | ||
| you may add a comma separated sequence--> | ||
| <!-- Replace XXX with the issue number resolved by this PR, if this PR fully resolves an issue. | ||
| If it does not fully resolve any issues, replace with something like "Related to #XXX", | ||
| or "Fixes part of #YYY but does not fully close it." | ||
| If it resolves multiple issues, repeat "closes" for each, like "Closes #XXX, closes #YYY." --> | ||
| Closes #XXX | ||
|
|
||
| ## Overview | ||
| <!-- Please provide a few bullet points summarizing the changes in this PR. This should include | ||
| points on any bug fixes, new functions, or other changes that have been made. --> | ||
|
|
||
| ## Expected Usage | ||
| <!-- If you are adding a feature into the Internal API, please produce a short example of it in action. | ||
| <!-- If this PR adds a new feature, please provide a short example of it in action. | ||
| You may ignore this step if it is not applicable (comment out this section). --> | ||
| ```Python | ||
| import uxarray as ux | ||
|
|
@@ -25,16 +27,15 @@ some_output = uxds.some_function() | |
|
|
||
| # this is another way to use this function | ||
| other_output = uxds.some_function(some_param = True) | ||
|
|
||
| ``` | ||
|
|
||
| ## 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** | ||
| - [ ] An issue is linked created and linked | ||
| - [ ] Add appropriate labels | ||
| - [ ] An issue is created and linked | ||
| - [ ] Added appropriate labels (if you have label edit permissions) | ||
| - [ ] Filled out Overview and Expected Usage (if applicable) sections | ||
|
|
||
| **Testing** | ||
|
|
@@ -44,24 +45,25 @@ apply to this PR, comment it out or delete it. --> | |
|
|
||
| **Documentation** | ||
| - [ ] Docstrings have been added to all new functions | ||
| - [ ] Docstrings have updated with any function changes | ||
| - [ ] Internal functions have a preceding underscore (`_`) and have been added to `docs/internal_api/index.rst` | ||
| - [ ] User functions have been added to `docs/user_api/index.rst` | ||
| - [ ] Docstrings have been updated with any function changes | ||
| - [ ] User (public) functions have been added to `docs/api.rst` | ||
| - [ ] Internal (private) function names start with an underscore (`_`) | ||
|
|
||
|
|
||
| **Examples** | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe add something about this section can/should be removed if no work on examples was conducted in this PR? |
||
| - [ ] Any new notebook examples added to `docs/examples/` folder | ||
| - [ ] Clear the output of all cells before committing | ||
| - [ ] 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/` | ||
| - [ ] New notebook examples cleared the output of all cells before committing | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not only new actually, Any notebooks that the PR's owner played with in their local might need this. Please rephrase accordingly |
||
| - [ ] New notebook examples added to appropriate folder (gallery: `docs/examples/`; guide: `docs/user-guide/`; quickstart: `docs/getting-started/`) | ||
| - [ ] New notebook examples referenced in appropriate .rst file (gallery: `docs/gallery.rst`; guide: `docs/userguide.rst`; quickstart: `docs/quickstart.rst`) | ||
| - [ ] New notebook gallery examples added 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: | ||
|
|
||
| **PR Etiquette Reminders** | ||
| - This PR should be listed as a draft PR until you are ready to request reviewers | ||
| - This PR should be listed as a draft PR until you are ready for it to be reviewed | ||
|
|
||
| - After making changes in accordance with the reviews, re-request your reviewers | ||
| - After making changes in accordance with any reviews, re-request reviews from the same reviewers | ||
|
|
||
| - Do *not* mark conversations as resolved if you didn't start them | ||
|
|
||
|
|
||
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.
Maybe add something about this section can/should be removed if no work on testing suite was conducted in this PR?