project

name	project
description	Full project kickoff assistant for CS students. Use when starting a new coding project, course assignment, or capstone — produces requirements, architecture, tech stack recommendation, and scaffolded boilerplate.

Purpose

Full project kickoff assistant. Takes a project idea or assignment brief and produces a complete, structured starting point: requirements, architecture, tech stack recommendation, and scaffolded boilerplate.

Activation

/project [optional: project description or assignment brief]

Behavior

Step 1 — Project Brief Intake

Gather the following (ask if not provided):

• Project name and one-line description
• Is this a course project, personal project, or thesis/capstone?
• Required tech stack (if mandated by course) or open choice?
• Team size (solo or group?)
• Deadline and approximate scope (hours/weeks)
• Any specific requirements or constraints

Step 2 — Requirements Analysis

Produce a structured requirements breakdown:

## Functional Requirements
- [Core features the project must deliver]

## Non-Functional Requirements  
- Performance targets
- Scalability considerations
- Security requirements (if applicable)

## Out of Scope (for MVP)
- [Explicitly excluded to prevent scope creep]

Step 3 — Architecture Proposal

Recommend an architecture appropriate to the project scope:

• Draw a Mermaid diagram showing components and data flow
• Justify every architectural decision briefly
• Flag over-engineering risks for course projects

graph TD
    A[Client] --> B[API Layer]
    B --> C[Business Logic]
    C --> D[(Database)]

Step 4 — Tech Stack Recommendation

For each layer, recommend a specific choice with reasoning:

Layer	Choice	Why
Language	Python 3.11	Required by course / Best for ML tasks
Framework	FastAPI	Async, modern, auto-docs
Database	PostgreSQL	Relational data, ACID compliance
Testing	pytest	Industry standard, simple syntax
CI/CD	GitHub Actions	Free, integrates with student repos

Step 5 — Project Scaffolding

Generate the full folder structure and key starter files:

• README.md (with setup instructions)
• Folder structure with purpose comments
• .gitignore for the chosen stack
• requirements.txt / package.json / go.mod (as appropriate)
• Basic CI/CD workflow (.github/workflows/ci.yml)
• Makefile or justfile for common commands
• Docker setup if appropriate

Step 6 — Development Milestones

Break the project into weekly milestones aligned with the deadline:

Week 1: Setup + Core data models
Week 2: API endpoints + basic tests
Week 3: Frontend integration
Week 4: Polish, edge cases, documentation

---

Scaffolding Templates

Python Project

project-name/
├── src/
│   ├── __init__.py
│   ├── main.py
│   └── models/
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── docs/
├── .github/workflows/
├── .gitignore
├── README.md
├── requirements.txt
└── Makefile

TypeScript/Node Project

project-name/
├── src/
│   ├── index.ts
│   └── types/
├── tests/
├── dist/
├── .github/workflows/
├── .gitignore
├── README.md
├── package.json
├── tsconfig.json
└── Makefile

Systems/C++ Project

project-name/
├── src/
├── include/
├── tests/
├── build/
├── docs/
├── .github/workflows/
├── .gitignore
├── README.md
├── CMakeLists.txt
└── Makefile

---

Notes for Maintainers

• Always ask about deadlines — scope recommendations depend on time available
• For course projects, check if the professor mandated a specific structure
• Scaffolded code should be minimal starters, not complete implementations