hackforla / hackforla/website

Create wiki page to guide developers how to manage CodeQL alerts

Open
#6,463 58 comments 0 reactions 0 assignees View on GitHub
Complexity: Medium Feature: Code Alerts Feature: Wiki role: back end/devOps role: front end size: 1pt
Dominant language
JavaScript
Stars
363
Forks
872
Avg merge
2d 21h
Merged PRs (30d)
18

Description

### Overview
We require a wiki page to guide developers how to manage and resolve CodeQL alerts

### Action Items
- [ ] We are currently in the process of moving the old wiki to the new [website-wiki repo](https://github.com/hackforla/website-wiki), so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read [How to Contribute to the Wiki](https://github.com/hackforla/website/wiki/How-to-Contribute-to-the-Wiki)
- [ ] Create a wiki page "How to manage CodeQL alerts" that covers the following topics:
- [ ] Overview of code scanning and its implementation in code.yml workflow
- [ ] Important elements of the code scanning alert page and details, including the concept of the tracking issue
- [ ] How to use alert tags to determine if an alert represents a security risk
- [ ] Example query to find closed alerts of a specific query type
- [ ] Options for resolving alerts
- [ ] how to resolve specific alert query types
- [ ] Unused variable, import, function or class (for sample resolution see https://github.com/hackforla/website/security/code-scanning/94)
- [ ] Potentially unsafe external link (see sample resolved alert https://github.com/hackforla/website/security/code-scanning/3)
- [ ] Malformed id attribute (see sample https://github.com/hackforla/website/security/code-scanning/25)
- [ ] Missing variable declaration (for sample resolution see https://github.com/hackforla/website/security/code-scanning/49)
- [ ] Use of returnless function
- [ ] Syntax error (see sample https://github.com/hackforla/website/security/code-scanning/97 not resolved)
- [ ] Inclusion of functionality from an untrusted source (see sample resolution https://github.com/hackforla/website/security/code-scanning/37)
- [ ] Superfluous trailing arguments (for sample resolution see https://github.com/hackforla/website/security/code-scanning/35)

### After this issue is completed
- [ ] Release dependency on #5242

### Resources/Instructions

- This issue resulted from #5005

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.