Skip to content

Commit

Permalink
add PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipMay committed Jan 1, 2024
1 parent b57c6d3 commit d740620
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Description

<!-- Please describe your pull request here. -->

## Pull request checklist

- [ ] add tests
- documentation
- [ ] add docstrings
- [ ] if a module is new: add API reference file for Sphinx in `docs/source/api-reference`
- [ ] check API doc of Sphinx - build and show with `make sphinx && make open-sphinx`
- [ ] fix checks
- start locale checks with `make check`
- fix formatting with `make format`
- Python type info
- [ ] check and improve Python type info
- [ ] double check if return types are specified - inclusing `-> None`
- [ ] check TODO comments in code
- [ ] check FIXME comments in code
- [ ] check if the copyright header needs an update

0 comments on commit d740620

Please sign in to comment.