Skip to content

Commit b955a0a

Browse files
timothywarnertimothywarner
authored
Merge pull request #1 from timothywarner-org/claude/setup-repo-documentation-01ETtPEGWsub3u4W3gmoy4e1
Create README and repository metadata for cybersecurity training
2 parents 35c1a14 + 5765318 commit b955a0a

3 files changed

Lines changed: 476 additions & 2 deletions

File tree

‎.github/REPOSITORY_SETTINGS.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Repository Settings & Configuration
2+
3+
This document outlines the recommended settings for the GitHub repository.
4+
5+
## Repository Topics
6+
7+
Add these topics to improve discoverability. Go to **Settings > General > Topics** or click "About" on the repo homepage.
8+
9+
### Recommended Topics (copy-paste ready)
10+
11+
```
12+
github-copilot
13+
cybersecurity
14+
security
15+
devsecops
16+
vulnerability-detection
17+
secure-coding
18+
owasp
19+
sql-injection
20+
xss
21+
penetration-testing
22+
sast
23+
dast
24+
compliance
25+
nist
26+
cis-benchmarks
27+
zero-trust
28+
threat-modeling
29+
security-automation
30+
incident-response
31+
infrastructure-as-code
32+
video-course
33+
training
34+
```
35+
36+
### Topic Categories
37+
38+
| Category | Topics |
39+
|----------|--------|
40+
| AI/Copilot | `github-copilot`, `ai-assisted-development`, `copilot-chat` |
41+
| Security | `cybersecurity`, `security`, `devsecops`, `secure-coding`, `appsec` |
42+
| Vulnerabilities | `owasp`, `vulnerability-detection`, `sql-injection`, `xss`, `penetration-testing` |
43+
| Testing | `sast`, `dast`, `security-testing`, `fuzz-testing` |
44+
| Compliance | `compliance`, `nist`, `cis-benchmarks`, `stig`, `security-compliance` |
45+
| Architecture | `zero-trust`, `threat-modeling`, `security-architecture` |
46+
| Automation | `security-automation`, `incident-response`, `infrastructure-as-code` |
47+
| Content Type | `video-course`, `training`, `tutorial`, `educational` |
48+
49+
## Labels
50+
51+
Labels are defined in `.github/labels.yml`. To sync labels:
52+
53+
```bash
54+
# Using github-label-sync
55+
npx github-label-sync --access-token $GITHUB_TOKEN --labels .github/labels.yml timothywarner-org/github-security-testbed
56+
```
57+
58+
## Repository Description
59+
60+
**Suggested description:**
61+
> Hands-on demo repository for "GitHub Copilot for Cybersecurity Specialists" video course - vulnerability detection, security protocols, automated testing, and compliance automation.
62+
63+
## Social Preview Image
64+
65+
Consider adding a custom social preview image (1280x640 recommended) that includes:
66+
- Course title
67+
- Key topics (Copilot, Security, DevSecOps)
68+
- Professional security-themed design
69+
70+
Upload at: **Settings > General > Social preview**
71+
72+
## Branch Protection (Optional)
73+
74+
For the main branch, consider enabling:
75+
- Require pull request reviews before merging
76+
- Require status checks to pass
77+
- Include administrators in restrictions
78+
79+
## Security Settings
80+
81+
- Enable Dependabot alerts
82+
- Enable Dependabot security updates
83+
- Enable secret scanning
84+
- Enable push protection for secrets

‎.github/labels.yml‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
# GitHub Labels for Course Repository
2+
# These labels can be applied using GitHub's label management or tools like github-label-sync
3+
# Usage: npx github-label-sync --access-token [token] --labels .github/labels.yml [owner/repo]
4+
5+
# =============================================================================
6+
# LESSON LABELS - Track content by lesson
7+
# =============================================================================
8+
- name: "lesson-01"
9+
color: "1f77b4"
10+
description: "Vulnerability Detection with GitHub Copilot"
11+
12+
- name: "lesson-02"
13+
color: "ff7f0e"
14+
description: "Implement Security Protocols"
15+
16+
- name: "lesson-03"
17+
color: "2ca02c"
18+
description: "Automated Security Testing"
19+
20+
- name: "lesson-04"
21+
color: "d62728"
22+
description: "Security Code Review, Threat Modeling & Auditing"
23+
24+
- name: "lesson-05"
25+
color: "9467bd"
26+
description: "Compliance, Incident Response & Configuration Management"
27+
28+
# =============================================================================
29+
# SECURITY TOPIC LABELS - Categorize by security domain
30+
# =============================================================================
31+
- name: "security/vulnerability"
32+
color: "b60205"
33+
description: "Vulnerability detection and remediation"
34+
35+
- name: "security/authentication"
36+
color: "5319e7"
37+
description: "Authentication and authorization topics"
38+
39+
- name: "security/encryption"
40+
color: "0e8a16"
41+
description: "Encryption and cryptography"
42+
43+
- name: "security/xss"
44+
color: "d93f0b"
45+
description: "Cross-Site Scripting (XSS) related"
46+
47+
- name: "security/sql-injection"
48+
color: "e99695"
49+
description: "SQL Injection related"
50+
51+
- name: "security/zero-trust"
52+
color: "006b75"
53+
description: "Zero Trust Architecture"
54+
55+
- name: "security/compliance"
56+
color: "fbca04"
57+
description: "Compliance and regulatory topics (CIS, NIST, STIG)"
58+
59+
- name: "security/incident-response"
60+
color: "c2e0c6"
61+
description: "Incident response and playbooks"
62+
63+
# =============================================================================
64+
# CONTENT TYPE LABELS - Identify type of content
65+
# =============================================================================
66+
- name: "type/demo"
67+
color: "0075ca"
68+
description: "Demo code or walkthrough"
69+
70+
- name: "type/exercise"
71+
color: "7057ff"
72+
description: "Hands-on exercise for learners"
73+
74+
- name: "type/reference"
75+
color: "d4c5f9"
76+
description: "Reference material or documentation"
77+
78+
- name: "type/template"
79+
color: "bfdadc"
80+
description: "Reusable template or boilerplate"
81+
82+
- name: "type/prompt"
83+
color: "c5def5"
84+
description: "Copilot prompt examples"
85+
86+
# =============================================================================
87+
# TOOL/TECHNOLOGY LABELS - Tag by tools used
88+
# =============================================================================
89+
- name: "tool/copilot"
90+
color: "8A2BE2"
91+
description: "GitHub Copilot related"
92+
93+
- name: "tool/copilot-chat"
94+
color: "6f42c1"
95+
description: "Copilot Chat specific"
96+
97+
- name: "tool/sast"
98+
color: "1d76db"
99+
description: "Static Application Security Testing"
100+
101+
- name: "tool/dast"
102+
color: "0366d6"
103+
description: "Dynamic Application Security Testing"
104+
105+
- name: "tool/terraform"
106+
color: "5c4ee5"
107+
description: "Terraform/Infrastructure as Code"
108+
109+
- name: "tool/github-actions"
110+
color: "2088ff"
111+
description: "GitHub Actions CI/CD"
112+
113+
# =============================================================================
114+
# STATUS LABELS - Track content status
115+
# =============================================================================
116+
- name: "status/ready"
117+
color: "0e8a16"
118+
description: "Content is ready for use"
119+
120+
- name: "status/in-progress"
121+
color: "fbca04"
122+
description: "Content is being developed"
123+
124+
- name: "status/needs-review"
125+
color: "f9d0c4"
126+
description: "Content needs review"
127+
128+
- name: "status/needs-update"
129+
color: "e4e669"
130+
description: "Content needs updating"
131+
132+
# =============================================================================
133+
# DIFFICULTY LABELS - Indicate complexity level
134+
# =============================================================================
135+
- name: "difficulty/beginner"
136+
color: "7ee87e"
137+
description: "Suitable for beginners"
138+
139+
- name: "difficulty/intermediate"
140+
color: "fef2c0"
141+
description: "Intermediate level content"
142+
143+
- name: "difficulty/advanced"
144+
color: "f9a7a7"
145+
description: "Advanced level content"
146+
147+
# =============================================================================
148+
# GENERAL PURPOSE LABELS
149+
# =============================================================================
150+
- name: "good first issue"
151+
color: "7057ff"
152+
description: "Good for newcomers"
153+
154+
- name: "help wanted"
155+
color: "008672"
156+
description: "Extra attention needed"
157+
158+
- name: "question"
159+
color: "d876e3"
160+
description: "Further information requested"
161+
162+
- name: "enhancement"
163+
color: "a2eeef"
164+
description: "New feature or improvement"
165+
166+
- name: "bug"
167+
color: "d73a4a"
168+
description: "Something isn't working"
169+
170+
- name: "documentation"
171+
color: "0075ca"
172+
description: "Documentation improvements"

0 commit comments

Comments
 (0)