Update PR template with CodeQL instructions #7616

santisecco · 2024-10-21T17:55:21Z

What changes did you make?

Modified PR template pull_request_template.md adding CodeQL instructions section. Please refer to the links below. Added more changes to the ones proposed in Update PR template with instructions regarding CodeQL annotations #5196 after conversation in dev meeting to add further clarity to the PR's instructions.

Why did you make the changes (we will use this info to test)?

We need developers to check the PR for annotations/comments resulting from CodeQL scanning. This will ensure better Security and Code Quality and give the chance of fixing changes before they are merged.

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

No visual changes to the website itself.
Even though, the following links are there to preview the changes to the Pull Request template.

Previous PR template: https://github.com/hackforla/website/blob/gh-pages/.github/pull_request_template.md
Updated PR template: https://github.com/santisecco/website/blob/update-pr-template-codeql-5196/.github/pull_request_template.md

…g annotations

github-actions · 2024-10-21T17:55:54Z

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

git checkout -b santisecco-update-pr-template-codeql-5196 gh-pages
git pull https://github.com/santisecco/website.git update-pr-template-codeql-5196

pluto-bell

Thank you for the descriptive PR, in which you indicated why there are additional changes made that are not found in the original issue. I also appreciate the before and after links to the template files.

Overall, great work on this PR.

FamousHero · 2024-10-22T02:26:25Z

Availability: 5-7pm, Mon-Fri
ETA: EOD Tues, Oct 21

Thinking-Panda · 2024-10-22T20:07:59Z

@santisecco Were these suggestions from you approved by any of the dev leads?
#5196 (comment)

santisecco · 2024-10-22T21:08:18Z

@santisecco Were these suggestions from you approved by any of the dev leads? #5196 (comment)

Yes

k-cardon · 2024-10-23T20:54:03Z

Availability: evenings / weekends
ETA: EOD Thursday

codyyjxn

@santisecco Great Job! Thank you for taking on this issue .

The branch name is correct
The issue is linked correctly
The description is clear and concise.

Thank you for your contribution! Keep it up

k-cardon

Branch, PR description, and code all look correct; screenshots of before and after template are helpful, thanks! I am requesting changes because the syntax of the added text is confusing--I know that's language from the original issue, but I think it would be helpful to fix at this stage before merging. I'll mark inline the changes I'm requesting.

k-cardon

1/2 changes requested (clarify complexity)

.github/pull_request_template.md

FamousHero

LGTM
Things you did well:

Description clear
Issue # in PR and branch name
Reasoning for going deviating from Actionable Items
Providing before and after

Things to work on:

N/A

Keep up the good work!

santisecco · 2024-10-27T17:03:11Z

Fixes #replace_this_text_with_the_issue_number

What changes did you make?

Why did you make the changes (we will use this info to test)?

CodeQL Alerts

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

Check the PR's comments. If present on your PR, the CodeQL alert looks similar as shown

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)

Instructions for resolving CodeQL alerts

If CodeQL alert/annotations appear, refer to How to Resolve CodeQL alerts.

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

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

Visuals before changes are applied

Visuals after changes are applied

k-cardon · 2024-10-27T17:55:43Z

This looks great @santisecco! Could you update the branch and I'll approve it?

santisecco · 2024-10-28T19:01:16Z

@FamousHero @pluto-bell @codyyjxn I requested again your reviews. I don't know if that could have been skipped had I changed the code differently.

Basically I added what @t-will-gillis and @k-cardon suggested and a new screenshot showing one alert instead of two which was asked by Bonnie in the meeting.

t-will-gillis

Hey @santisecco This looks great- thanks for asking the questions and working with everyone to improve this issue!

k-cardon

Looks great, very clear now, thanks!

t-will-gillis · 2024-10-29T02:25:46Z

@FamousHero @pluto-bell @codyyjxn FYI I will merge this since you previously Approved this PR

santisecco and others added 4 commits September 28, 2024 18:12

Updated PR template code to add instructions regarding CodeQL scannin…

a076fd5

…g annotations

Merge branch 'hackforla:gh-pages' into update-pr-template-codeql-5196

737d93c

Merge branch 'hackforla:gh-pages' into update-pr-template-codeql-5196

be09a42

Update pull_request_template.md

405471a

github-actions bot added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Medium size: 0.5pt Can be done in 3 hours or less Feature: Code Alerts labels Oct 21, 2024

santisecco changed the title ~~Update pr template codeql 5196~~ Update PR template CodeQL Oct 21, 2024

santisecco changed the title ~~Update PR template CodeQL~~ Update PR template with CodeQL instructions Oct 21, 2024

pluto-bell self-requested a review October 21, 2024 19:13

pluto-bell previously approved these changes Oct 21, 2024

View reviewed changes

pluto-bell mentioned this pull request Oct 21, 2024

Skills Issue: Developer: pluto bell #7200

Open

FamousHero self-requested a review October 22, 2024 02:25

Thinking-Panda self-requested a review October 22, 2024 20:05

k-cardon self-requested a review October 23, 2024 20:52

codyyjxn self-requested a review October 24, 2024 20:06

codyyjxn previously approved these changes Oct 24, 2024

View reviewed changes

k-cardon requested changes Oct 25, 2024

View reviewed changes

.github/pull_request_template.md Outdated Show resolved Hide resolved

k-cardon reviewed Oct 25, 2024

View reviewed changes

.github/pull_request_template.md Outdated Show resolved Hide resolved

k-cardon mentioned this pull request Oct 25, 2024

Skills Issue: Developer: Kristen Cardon #7326

Open

FamousHero previously approved these changes Oct 25, 2024

View reviewed changes

Update pull_request_template.md

72b6d1b

santisecco dismissed stale reviews from FamousHero, codyyjxn, and pluto-bell via 72b6d1b October 28, 2024 18:54

santisecco requested a review from k-cardon October 28, 2024 18:57

santisecco requested review from FamousHero, pluto-bell, codyyjxn and t-will-gillis October 28, 2024 19:01

t-will-gillis approved these changes Oct 28, 2024

View reviewed changes

k-cardon approved these changes Oct 28, 2024

View reviewed changes

t-will-gillis merged commit 3e06d99 into hackforla:gh-pages Oct 29, 2024
3 checks passed

FamousHero mentioned this pull request Nov 1, 2024

Skills Issue: Developer: Daniel Franco #7327

Open

santisecco mentioned this pull request Nov 15, 2024

Pre-work Checklist: Developer: [Santiago Secco Vidal] #6426

Closed

31 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update PR template with CodeQL instructions #7616

Update PR template with CodeQL instructions #7616

santisecco commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

pluto-bell left a comment

FamousHero commented Oct 22, 2024

Thinking-Panda commented Oct 22, 2024

santisecco commented Oct 22, 2024 •

edited

Loading

k-cardon commented Oct 23, 2024

codyyjxn left a comment

k-cardon left a comment

k-cardon left a comment •

edited

Loading

FamousHero left a comment

santisecco commented Oct 27, 2024 •

edited

Loading

k-cardon commented Oct 27, 2024

santisecco commented Oct 28, 2024

t-will-gillis left a comment

k-cardon left a comment

t-will-gillis commented Oct 29, 2024

Update PR template with CodeQL instructions #7616

Update PR template with CodeQL instructions #7616

Conversation

santisecco commented Oct 21, 2024

What changes did you make?

Why did you make the changes (we will use this info to test)?

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

github-actions bot commented Oct 21, 2024

pluto-bell left a comment

Choose a reason for hiding this comment

FamousHero commented Oct 22, 2024

Thinking-Panda commented Oct 22, 2024

santisecco commented Oct 22, 2024 • edited Loading

k-cardon commented Oct 23, 2024

codyyjxn left a comment

Choose a reason for hiding this comment

k-cardon left a comment

Choose a reason for hiding this comment

k-cardon left a comment • edited Loading

Choose a reason for hiding this comment

FamousHero left a comment

Choose a reason for hiding this comment

santisecco commented Oct 27, 2024 • edited Loading

What changes did you make?

Why did you make the changes (we will use this info to test)?

CodeQL Alerts

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

k-cardon commented Oct 27, 2024

santisecco commented Oct 28, 2024

t-will-gillis left a comment

Choose a reason for hiding this comment

k-cardon left a comment

Choose a reason for hiding this comment

t-will-gillis commented Oct 29, 2024

santisecco commented Oct 22, 2024 •

edited

Loading

k-cardon left a comment •

edited

Loading

santisecco commented Oct 27, 2024 •

edited

Loading