hackforla / website

Hack for LA's website
https://www.hackforla.org
GNU General Public License v2.0
323 stars 775 forks source link

Create issues to resolve all open CodeQL alerts #5159

Open roslynwythe opened 1 year ago

roslynwythe commented 1 year ago

Overview

Create issues to resolve open CodeQL alerts

Issues to create (this issue should remain open until these are closed)

Currently as of 4/7/2024 alerts exist up to 107. Alerts not listed above are in Pull Requests.

Action Items

Template

### Prerequisite
1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our [Getting Started page](https://www.hackforla.org/getting-started).
2. Before you claim or start working on an issue, please make sure you have read our [How to Contribute to Hack for LA Guide](https://github.com/hackforla/website/blob/7f0c132c96f71230b8935759e1f8711ccb340c0f/CONTRIBUTING.md).

### Overview
As developers. we need to analyze [CodeQL query alert INSERT-ALERTID](https://github.com/hackforla/website/security/code-scanning/INSERT-ALERTID) and to either recommend dismissal of the alert or update the code to resolve the alert.    

### Action Items
- [ ] DO NOT DISMISS ANY ALERTS.  Dismissal of alerts should be done by dev leads only after review of the recommendation
- [ ] Browse to the link in the next Action Item and read the contents.  Click "See More" to view Recommendations, Examples and References.  
- [ ] https://github.com/hackforla/website/security/code-scanning/INSERT-ALERTID 
- [ ] Note these resources: 
   - [ ] See the wiki page "How to manage CodeQL alerts" (see under Resources)
   - [ ] To look at the resolution of similar alerts, visit the [code scanning page](https://github.com/hackforla/website/security/code-scanning) and query closed alerts for similar alert type.  To see the resolution of a closed alert, view the alert details and open the tracking issue (outlined in red in the screenshot under Resources)
- [ ] In a comment in this issue, provide your recommendation.  The recommendation can be one of the following: `dismiss as test`, `dismiss as false positive`, `dismiss as won't fix`, or `update code`.  An example of a 'false positive' is a report of a JavaScript syntax error that is caused by markdown or liquid symbols such as `---` or `{%`.  
- [ ] If the recommendation is to update code:
   - [ ] create an issue branch and proceed with the code update
   - [ ] Use docker to test locally, ensuring that there are no changes to the appearance or the behavior of any affected webpage(s) or GitHub actions.  If you are not certain how to test a particular code change, ask a merge team member or dev lead.  
   - [ ] proceed with pull request in the usual manner 
- [ ] If the recommendation is to dismiss, describe your reason for dismissal in the comment, then move the issue to `Questions/In Review` and apply the label `ready for dev lead`.  

### For merge team/dev lead
- [ ] If recommendation to dismiss is approved, dismiss the alert with a comment, then close the issue as completed.
- [ ] When this issue is closed please check off the dependency (under "Issues") in #5159.  If all issues are closed, close #5159 as completed.  

### Resources/Instructions

- [GitHub CodeQL documentation](https://codeql.github.com/docs/codeql-overview/about-codeql/)
- [code scanning page](https://github.com/hackforla/website/security/code-scanning)
- Wiki page "How to resolve CodeQL alerts" (if this page has not been published yet, see the draft at https://github.com/hackforla/website/issues/6463#issuecomment-2002573270)
- This issue is part of #5159

Resources/Instructions

ExperimentsInHonesty commented 8 months ago

I have added the following note to the agenda for 2024-03-04 BW: CodeQL issue making review

If most of the issues already made are medium, it looks like there are 57 medium issues we could make from the HfLA website: CodeQL scan alerts (issue #5060) spreadsheet. Is that correct? If we clear up how to manage https://github.com/hackforla/website/issues/5005 , we could remove RW from it, correct?

roslynwythe commented 8 months ago

I have added the following note to the agenda for 2024-03-04 BW: CodeQL issue making review

If most of the issues already made are medium, it looks like there are 57 medium issues we could make from the HfLA website: CodeQL scan alerts (issue #5060) spreadsheet. Is that correct? If we clear up how to manage #5005 , we could remove RW from it, correct?