diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 52e5160c3..183bfaf90 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,10 @@ - + Closes #XXX ## Overview @@ -10,7 +12,7 @@ Closes #XXX points on any bug fixes, new functions, or other changes that have been made. --> ## Expected Usage - ```Python import uxarray as ux @@ -25,43 +27,46 @@ some_output = uxds.some_function() # this is another way to use this function other_output = uxds.some_function(some_param = True) - ``` ## PR Checklist - + **General** -- [ ] An issue is linked created and linked -- [ ] Add appropriate labels +- [ ] An issue is created and linked +- [ ] Added appropriate labels (if your uxarray repo permissions allow it) - [ ] Filled out Overview and Expected Usage (if applicable) sections -**Testing** +**Testing & Benchmarking** + - [ ] Adequate tests are created if there is new functionality - [ ] Tests cover all possible logical paths in your function - [ ] Tests are not too basic (such as simply calling a function and nothing else) +- [ ] At least one ASV benchmark demonstrates improvements, if expected (add a new benchmark if necessary) **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** -- [ ] 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/` + +- [ ] **All** notebook examples cleared the output of all cells before committing +- [ ] 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/`