Introduce a PR template. Now this is exactly the same PR template as in neural-lam, with the only change that the line asking to update the readme has been changed to ask for updating the documentation. This makes sense for this repository as code changes in general should not impact the documentation in the readme, but in the designated jupyter book documentation.
Type of change
[ ] 🐛 Bug fix (non-breaking change that fixes an issue)
[ ] ✨ New feature (non-breaking change that adds functionality)
[ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] 📖 Documentation (Addition or improvements to documentation)
Checklist before requesting a review
[x] My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
[x] I have performed a self-review of my code
[x] For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
[x] I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
[x] I have updated the documentation to cover introduced code changes
[x] I have added tests that prove my fix is effective or that my feature works
[x] I have given the PR a name that clearly describes the change, written in imperative form (context).
[x] I have requested a reviewer and an assignee (assignee is responsible for merging)
Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
[x] the code is readable
[x] the code is well tested
[x] the code is documented (including return types and parameters)
[x] the code is easy to maintain
Author checklist after completed review
[ ] I have added a line to the CHANGELOG describing this change, in a section
reflecting type of change (add section where missing):
added: when you have added new functionality
changed: when default behaviour of the code has been changed
fixes: when your contribution fixes a bug
Checklist for assignee
[ ] PR is up to date with the base branch
[ ] the tests pass
[ ] author has added an entry to the changelog (and designated the change as added, changed or fixed)
Once the PR is ready to be merged, squash commits and merge the PR.
leifdenby
commented
2 months ago
Describe your changes
Introduce a PR template. Now this is exactly the same PR template as in neural-lam, with the only change that the line asking to update the readme has been changed to ask for updating the documentation. This makes sense for this repository as code changes in general should not impact the documentation in the readme, but in the designated jupyter book documentation.
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
Checklist for assignee