From 0f44254d79e2a9b72631a5661c0e01c80256cebc Mon Sep 17 00:00:00 2001 From: Joe Gilliland-Lloyd <6943710+joegl@users.noreply.github.com> Date: Thu, 19 Dec 2024 10:02:01 -0600 Subject: [PATCH] HSD8-1664: Updated PR template (#1685) * Updated PR template. * Updated sanitiztion line. * dropped ready for review title. added review tasks heading. --------- Co-authored-by: joegl <20383-joegl@users.noreply.drupalcode.org> --- .github/pull_request_template.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1290ef73e..f80939991 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,8 @@ -# READY FOR REVIEW - -## Summary -_[briefly summarize the changes here]_ +# Summary +_[briefly summarize the changes here. TL;DR - what's this PR for?]_ ## Need Review By (Date) -_['10/30', 'asap', etc.]_ +_[When does this need to be reviewed by? '10/30', 'asap', etc.]_ ## Urgency _['low', 'medium', 'high', etc.]_ @@ -13,6 +11,22 @@ _['low', 'medium', 'high', etc.]_ 1. _[First testing step]_ 2. ... -## PR Checklist -- [PR Checklist](https://gist.github.com/sherakama/0ba17601381e3adbe0cad566ad4d80a5) -- [Humsci Basic PR Checklist](https://github.com/SU-HSDO/suhumsci/blob/develop/docs/HumsciBasicPRChecklist.md) +# Review Tasks + +## Backend / Functional Validation +### Code +- [ ] Are the naming conventions following our standards? +- [ ] Are PHP functions and variables in `snake_case` and not `camelCase`? +- [ ] Does Drupal code follow [Drupal Coding Standards](https://www.drupal.org/docs/develop/standards/php/php-coding-standards)? +- [ ] Does the code have sufficient inline comments? +- [ ] Is there anything in this code that would be hidden or hard to discover through the UI? +- [ ] Are there any [code smells](https://blog.codinghorror.com/code-smells/)? +- [ ] Are tests provided? + +### Code security +- [ ] Is all [user input properly sanitized when rendered](https://www.drupal.org/docs/8/security/drupal-8-sanitizing-output)? +- [ ] Any obvious [security flaws or new areas for attack](https://www.drupal.org/docs/8/security)? + +### General +- [ ] Is there anything included in this PR that is not related to the problem it is trying to solve? +- [ ] Is the approach to the problem appropriate?