github-samples / github-samples/pets-workshop
GitHub security workshop: Teach code scanning alert investigation and triage
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 80
- Forks
- 161
- Avg merge
- 31m
- Merged PRs (30d)
- 1
Description
Goal
Move beyond enabling CodeQL by teaching learners to understand, prioritize, and disposition a code scanning alert.
Scope
Build an investigation exercise around the deterministic alert from the prior lab. Cover the alert summary, severity, CWE, source-to-sink path, affected branch or pull request, status, and appropriate resolution choices. Do not rely only on screenshots or exact control positions.
Acceptance criteria
- Learners locate the alert from both the pull request/check context and repository Security experience.
- The exercise explains severity, precision, CWE, query help, data-flow steps, and affected branches.
- Learners distinguish a true positive, false positive, test-only finding, and accepted risk.
- Dismissal reasons and audit implications are explained without encouraging dismissal of the lab finding.
- Learners record a short triage decision and remediation plan.
- Plan- or role-dependent UI differences have a documented fallback.
- Completion is based on observable alert details rather than matching a screenshot.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the prior lab's deterministic alert and the existing workshop exercise structure. Use the pull request/check context and repository Security experience to verify the investigation flow, then ensure the exercise covers the listed alert details, triage outcomes, dismissal implications, UI fallbacks, and an observable triage decision without relying on screenshots.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100