cc-skill-project-guidelines-example
Project Guidelines Skill (Example)
By sickn33 · 530 installs
npx skills add sickn33/agentic-awesome-skills --skill cc-skill-project-guidelines-example
Source repository · Upstream listing
Project Guidelines Skill (Example)
This is an example of a project specific skill. Use this as a template for your own projects.
Based on a real production application: [Zenith](https://zenith.chat) AI powered customer discovery platform.
When to Use
Reference this skill when working on the specific project it's designed for. Project skills contain:
Architecture overview
File structure
Code patterns
Testing requirements
Deployment workflow
Architecture Overview
Tech Stack:
Frontend : Next.js 15 (App Router), TypeScript, React
Backend : FastAPI (Python), Pydantic models
Database : Supabase (PostgreSQL)
AI : Claude API with tool calling and structured output
Deployment : Google Cloud Run
Testing : Playwright (E2E), pytest (backend), React Testing Library
Services:
File Structure
Code Patterns
API Response Format (FastAPI)
Frontend API Calls (TypeScript)
Claude AI Integration (Structured Output)
Custom Hooks (React)
Testing Requirements
Backend (pytest)
Test structure:
Frontend (React Testing Library)
Test structure:
Deployment Workflow
Pre Deployment Checklist
[ ] All tests passing locally
[ ] npm run build succeeds (frontend)
[ ] poetry run pytest passes (backend)
[ ] No hardcoded secrets
[ ] Environment variables documented
[ ] Database migrations ready
Deployment Commands
Environment Variables
Critical Rules
1. No emojis in code, comments, or documentation
2. Immutability never mutate objects or arrays
3. TDD write tests before implementation
4. 80% coverage minimum
5. Many small files 200 400 lines typical, 800 max
6. No console.log in production code
7. Proper error handling with try/catch
8. Input validation with Pydantic/Zod
Related Skills
coding standards.md General coding best practices
backend patterns.md API and database patterns
frontend patterns.md React and Next.js patterns
tdd workflow/ Test driven development methodology
Limitations
Use this skill only when the task clearly matches the scope described above.
Do not treat the output as a substitute for environment specific validation, testing, or expert review.
Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.