Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PR template with instructions regarding CodeQL annotations #5196

Closed
2 tasks done
roslynwythe opened this issue Aug 14, 2023 · 17 comments · Fixed by #7616
Closed
2 tasks done

Update PR template with instructions regarding CodeQL annotations #5196

roslynwythe opened this issue Aug 14, 2023 · 17 comments · Fixed by #7616
Assignees
Labels
Complexity: Medium Feature: Code Alerts role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Milestone

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Aug 14, 2023

Overview

We need to direct developers to check the PR for annotations resulting from CodeQL (Security and Code Quality) scanning.

Action Items

  • Open the file .github/pull_request_template.md in your IDE
  • Following the section "Why did you make the changes (we will use this info to test)?" add this section:
<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. 

If your issue has a CodeQL alert and is complexity: medium or higher, please let us know that you have checked and resolved.  Please do not dismiss alerts.
- [ ] I have checked this PR for CodeQL alerts.  If CodeQL alerts were found:
   - [ ] I have resolved CodeQL alerts 
   - [ ] I believe this CodeQL alerts is a false positive (merge team will evaluate)
   - [ ] I am stuck (after reading instructions below)

<details><summary>Instructions</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> 


@roslynwythe roslynwythe added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing labels Aug 14, 2023
@github-actions

This comment has been minimized.

@roslynwythe roslynwythe added Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Code Alerts size: 0.5pt Can be done in 3 hours or less role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing labels Aug 14, 2023
@roslynwythe roslynwythe added the Dependency An issue is blocking the completion or starting of another issue label Aug 14, 2023
@wanyuguan wanyuguan added this to the 02. Security milestone Aug 19, 2023
@roslynwythe roslynwythe added Ready for Prioritization Draft Issue is still in the process of being created and removed Dependency An issue is blocking the completion or starting of another issue Ready for Prioritization labels Oct 8, 2023
@ExperimentsInHonesty

This comment was marked as resolved.

@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty ExperimentsInHonesty added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Mar 5, 2024

This comment has been minimized.

@t-will-gillis

This comment was marked as outdated.

@HackforLABot

This comment has been minimized.

@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to Make Issues: ERs and epics in P: HfLA Website: Project Board Sep 23, 2024
@izma-mujeeb izma-mujeeb self-assigned this Sep 25, 2024
@izma-mujeeb izma-mujeeb moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Sep 25, 2024
@HackforLABot

This comment has been minimized.

@HackforLABot HackforLABot moved this from In progress (actively working) to New Issue Approval in P: HfLA Website: Project Board Sep 25, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to Make Issues: ERs and epics in P: HfLA Website: Project Board Sep 26, 2024
@santisecco santisecco self-assigned this Sep 27, 2024
@HackforLABot

This comment has been minimized.

@santisecco
Copy link
Member

santisecco commented Sep 27, 2024

i. Availability: Friday-Sunday 9-27-24
ii. ETA: Saturday afternoon

@santisecco
Copy link
Member

santisecco commented Sep 28, 2024

Changes have been made.
However, I will ask in Sunday's meeting if I should test the PR template in my own repo before generating the pull request.

@santisecco santisecco moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Oct 1, 2024
@santisecco
Copy link
Member

I implemented the changes and opened a PR #7546, but after some feedback on the changes I closed it because I would like to ask the following before reopening it.

I wanted to suggest adding below "After the PR has been submitted and the resulting GitHub actions/checks have been completed, developers should check the PR for CodeQL alert annotations." something similar to:

"CodeQL alert annotations can be checked below the submitted PR. You will see something similar to:

Click here to see a visual example of the `GitHub actions/checks` below the PR.

You can click on show all checks to see CodeQL checks

"

I believe this or something else will make it easier for new developers to understand where to find the Checks and CodeQL alert annotations. But just wanted to point that out because it will affect all devs creating PRs.

Should I leave it as it is or add that?

@HackforLABot
Copy link
Contributor

@santisecco

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

You are receiving this comment because your last comment was before Tuesday, October 8, 2024 at 12:05 AM PST.

@HackforLABot HackforLABot added the To Update ! No update has been provided label Oct 11, 2024
@santisecco
Copy link
Member

I will address the concern tomorrow on the dev meeting.

@santisecco santisecco removed the To Update ! No update has been provided label Oct 13, 2024
@t-will-gillis t-will-gillis added Complexity: Medium and removed Complexity: Small Take this type of issues after the successful merge of your second good first issue labels Oct 20, 2024
@github-project-automation github-project-automation bot moved this from In progress (actively working) to QA in P: HfLA Website: Project Board Oct 29, 2024
@kgold2018 kgold2018 moved this from QA to Done in P: HfLA Website: Project Board Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment