diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..050bbb72 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## Issue +_Link to the issue resolved by this PR._ + +## Short description +_Short description of the approach taken to solve the issue_ + +## Pre-review checklist +- [ ] Read through all changes. No redundant `print()` statements, commented-out code, or other remnants from the development. ๐Ÿ‘€ +- [ ] Make sure tests pass after every commit. โœ… +- [ ] New/refactored code is following same conventions as the rest of the code base. ๐Ÿงฌ +- [ ] New/refactored code is tested. โš™ +- [ ] Documentation has been updated ๐Ÿงพ + +## Pre-merge checklist +- [ ] Commit history is consistent and clean. ๐Ÿ‘Œ