Skip to content

Commit

Permalink
Update PR template with CodeQL instructions (#7616)
Browse files Browse the repository at this point in the history
* Updated PR template code to add instructions regarding CodeQL scanning annotations

* Update pull_request_template.md

* Update pull_request_template.md
  • Loading branch information
santisecco authored Oct 29, 2024
1 parent 39d7540 commit 3e06d99
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,34 @@ Fixes #replace_this_text_with_the_issue_number
-
-

<h3>CodeQL Alerts</h3>


After the PR has been submitted and the resulting GitHub actions/checks have been completed, developers should check the PR for CodeQL alert annotations.


<details><summary>Check the PR's comments. If present on your PR, the CodeQL alert looks similar as shown</summary>

![Screenshot 2024-10-28 154514](https://github.com/user-attachments/assets/ea66c586-c14c-45fd-8705-1c116224e704)


</details>

Please let us know that you have checked for CodeQL alerts. **Please do not dismiss alerts.**
- [ ] I have checked this PR for CodeQL alerts and none were found.
- [ ] I found CodeQL alert(s), and (select one):
- [ ] I have resolved the CodeQL alert(s) as noted
- [ ] I believe the CodeQL alert(s) is a false positive (Merge Team will evaluate)
- [ ] I have followed the Instructions below, but I am still stuck (Merge Team will evaluate)

<details><summary>Instructions for resolving CodeQL alerts</summary>

If CodeQL alert/annotations appear, refer to [How to Resolve CodeQL alerts](https://github.com/hackforla/website/issues/6463#issuecomment-2002573270).

In general, CodeQL alerts should be resolved prior to PR reviews and merging

</details>

### Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)
<!-- Notes:
- If there are no visual changes to the website, delete all of the script below and replace with "- No visual changes to the website"
Expand Down

0 comments on commit 3e06d99

Please sign in to comment.