Skip to content

Commit 5606f59

Browse files
Kyle ParkerKyle Parker
authored andcommitted
Add missing project governance and employer-facing docs
1 parent 21c23ae commit 5606f59

File tree

5 files changed

+56
-0
lines changed

5 files changed

+56
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Code of Conduct
2+
3+
## Standards
4+
- Be respectful and collaborative
5+
- Offer constructive technical feedback
6+
- Keep discussion focused on code and product quality
7+
8+
## Unacceptable behavior
9+
- Harassment or discrimination
10+
- Personal attacks or hostile behavior
11+
12+
## Enforcement
13+
Maintainers may remove or reject contributions that violate this policy.

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,10 @@ python3 main.py
6969

7070
## License
7171
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file.
72+
73+
## Employer Quick Links
74+
- Project brief: `docs/PROJECT_BRIEF.md`
75+
- Resume bullets: `docs/RESUME_BULLETS.md`
76+
- Security policy: `SECURITY.md`
77+
- Contribution guide: `CONTRIBUTING.md`
78+
- Code of conduct: `CODE_OF_CONDUCT.md`

SECURITY.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Reporting vulnerabilities
4+
Please report vulnerabilities privately via GitHub Security Advisories.
5+
6+
## Scope
7+
- challenge validation logic
8+
- persistence and local file handling
9+
- dependency integrity and CI workflow
10+
11+
## Disclosure
12+
Do not publish exploit details before mitigation is available.

docs/PROJECT_BRIEF.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Project Brief: Code Quest (Python + SQL Trainer)
2+
3+
## Problem
4+
Early learners struggle to build coding confidence without immediate feedback and structured progression.
5+
6+
## Solution
7+
Code Quest provides a CLI learning game with Python/SQL challenges, hints, scoring, and progress persistence.
8+
9+
## Business/education value
10+
- Encourages repeat practice loops
11+
- Makes learning measurable through progression and score signals
12+
- Supports data-literacy and SQL readiness
13+
14+
## Technical highlights
15+
- Python game loop and challenge validation
16+
- SQLite-backed SQL challenge execution
17+
- Unit tests and CI workflow
18+
- Clear learner UX and progression mechanics

docs/RESUME_BULLETS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Resume Bullets
2+
3+
- Built a Python + SQL interactive training game with challenge validation, hints, and persistent user progression.
4+
- Implemented executable SQL exercises against SQLite datasets to strengthen real query reasoning in a guided format.
5+
- Added automated tests and CI checks to ensure stable behavior and reproducible results.
6+
- Designed an education-focused CLI product with measurable scoring and repeat-practice loops.

0 commit comments

Comments
 (0)