From b055d4a53c2b8862c22a8b60cbecca4fea1074c3 Mon Sep 17 00:00:00 2001 From: Subhradeep Bera <124783808+beradeep@users.noreply.github.com> Date: Mon, 4 Dec 2023 10:31:22 +0530 Subject: [PATCH] Create pull_request_template.md --- .github/pull_request_template.md | 51 ++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3a95a47 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,51 @@ +## Pull Request (PR) Checklist +Please check if your pull request fulfills the following requirements: +- [ ] The PR is submitted to the `master` branch. +- [ ] I confirm that I've run the code locally and everything works as expected. +- [ ] 🎬 I've attached a **screen recoding** of the changes (in case of UI changes). + +> Tip: drag & drop the video to the PR description. + +## What type of PR is this? (check all applicable) + +- [ ] Refactor +- [ ] Feature +- [ ] Bug Fix +- [ ] Optimization +- [ ] Documentation Update + +## What's changed? + + +Describe with a few bullets **what's new:** +- a +- b + +> 💡 Tip: Please, attach screenshots and screen recordings. It helps a lot! + +## Risk Factors + +**What may go wrong if we merge your PR?** + +- a +- b + +**In what cases your code won't work?** + +- a +- b + + +## Does this PR closes any GitHub Issues? + +Check **[CollegeSearch Issues](https://github.com/beradeep/CollegeSearch/issues)**. + +- Closes #ISSUE_NUMBER + +> Replace `ISSUE_NUMBER` with your issue number (for example Closes #1234). If you've done that correctly, you'll see the issue title linked when previewing your PR description.