github-samples / github-samples/pets-workshop

full-day workshop: Standardize code security settings navigation

Open
#262 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority: P1
Dominant language
Python
Stars
80
Forks
161
Avg merge
31m
Merged PRs (30d)
1

Description

Problem

content/full-day/1-code-scanning.md sends learners to Settings > Code security, but the Secret scanning and Code scanning sections then refer to Settings > Code security and analysis. A learner following the same page is given two names for the same settings destination.

The screenshots and labels are particularly important here because the controls vary with repository visibility and account features.

Suggested change

Verify the current GitHub settings experience and use one consistent navigation path throughout the exercise. Note any visibility or plan-dependent differences where needed.

Acceptance criteria

  • Dependabot, secret scanning, push protection, and CodeQL steps use current, consistent settings labels.
  • Screenshots match the labels used in the text.
  • The exercise states what learners should expect when a control is already enabled or unavailable.
  • The flow is validated in a public repository created from the template.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with content/full-day/1-code-scanning.md and verify the current GitHub settings experience in a public repository created from the template. Trace the Dependabot, secret scanning, push protection, and CodeQL steps, then align their labels and screenshots and document already-enabled or unavailable controls. Done means the full exercise uses consistent, current navigation and has been validated in the template repository.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.