From 26344c44193b9a9ef03f84869b41bf228163338d Mon Sep 17 00:00:00 2001 From: Johan Trieloff Date: Mon, 23 Oct 2023 10:59:47 +0200 Subject: [PATCH 1/2] added a PR template --- .github/pull_request_template.md | 4 ++++ 1 file changed, 4 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..ee8d658 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,4 @@ +# What Issue did you fix? +Fixes: # + +# Quick description of your approach: From 010fb4ac33e30162f8c91b174b01072550feba5a Mon Sep 17 00:00:00 2001 From: Johan Trieloff Date: Mon, 23 Oct 2023 11:05:57 +0200 Subject: [PATCH 2/2] added checklist --- .github/pull_request_template.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ee8d658..588dd2a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,3 +2,10 @@ Fixes: # # Quick description of your approach: + +## Checklist before requesting a review: +- [ ] I have removed the comments fron the questions +- [ ] I have added comments to my code, particularly in hard-to-understand areas +- [ ] I have removed all of the debugging 'console.logs' +- [ ] I have ensured that all of my variables, functions, etc. are named sensibly (Are able to be understood by someone who has not seen my code before) +- [ ] I have read through my changes to make sure that I did not change anything that was not related to the issue I am fixing