Skip to content

Commit

Permalink
HSD8-1664: Updated PR template (#1685)
Browse files Browse the repository at this point in the history
* Updated PR template.

* Updated sanitiztion line.

* dropped ready for review title. added review tasks heading.

---------

Co-authored-by: joegl <[email protected]>
  • Loading branch information
joegl and joegl authored Dec 19, 2024
1 parent d087ab8 commit 0f44254
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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.]_
Expand All @@ -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?

0 comments on commit 0f44254

Please sign in to comment.