From 17d4a5ccbc1d0592a195b55910205a4ee26faa2a Mon Sep 17 00:00:00 2001 From: Reinier Koops Date: Tue, 26 Mar 2024 15:03:49 +0100 Subject: [PATCH] add PR template (#250) This PR addresses the issue https://github.com/ing-bank/probatus/issues/212 --------- Co-authored-by: PaulZhutovsky --- .../PULL_REQUEST_TEMPLATE.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..152413a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ +--- +name: Pull Request +about: Propose changes to the codebase +title: '' +labels: '' +assignees: '' + +--- + +## Description +Please provide a summary of the changes you are proposing with this Pull Request. Include the motivation and context. Highlight any key changes. If this PR fixes an open issue, mention the #issue_number" in this PR. + +## Type of change +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## Checklist: +Go over all the following points, and put an "x" in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation/notebooks. +- [ ] I have updated the documentation or added a notebook accordingly. +- [ ] I have tested the code locally according to the **CONTRIBUTING.md** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. + +## How Has This Been Tested? +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. List any relevant details for your test configuration. + +## Screenshots (if applicable): +Include screenshots or gifs of the changes you have made. This is especially useful for UI changes. + +## Additional Context: +Add any other context or screenshots about the pull request here. This could include reasons for changes, decisions made, or anything you want the reviewer to know. + +--- + +**For more information on contributing, please see the [CONTRIBUTING.md](../../CONTRIBUTING.md) document.**