github-samples / github-samples/pets-workshop

GitHub security workshop: Add workshop structure, prerequisites, and safe lab setup

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

Nobody has claimed this yet.

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

Description

Goal

Create the entry point and setup exercise for a dedicated 2–3 hour GitHub security workshop built around the pets application. Learners should know before starting which repository visibility, GitHub plan, organization role, and optional Copilot access each exercise requires.

Scope

Add the workshop overview, navigation, timing, learning objectives, template-repository setup, and a capability preflight. Establish a safety contract for intentional vulnerabilities and secret-scanning demonstrations: use only documented test values, isolate lab branches, and provide reset instructions.

Acceptance criteria

  • content/security/README.md introduces the workshop, audience, duration, outcomes, and exercise sequence.
  • content/security/0-setup.md guides creation of a fresh public repository from the template and validates the app.
  • A capability matrix distinguishes features available for public repositories from features requiring organization, enterprise, or administrative access.
  • Copilot is identified as optional for the remediation exercise, with a manual path available.
  • Learners create or identify a disposable lab repository and branch strategy before introducing vulnerable examples.
  • The workshop explicitly prohibits real credentials and explains how intentional findings will be cleaned up.
  • Previous/next navigation and the root workshop selection page include the new track.
  • All links and setup steps are validated from a fresh template repository.

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 the existing workshop structure and add content/security/README.md and content/security/0-setup.md, then trace the root workshop selection and previous/next navigation for the new track. Validate setup from a fresh template repository, including the capability matrix, disposable lab and branch guidance, optional Copilot path, safety contract, and link correctness.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.