project-guidelines-example

The Project Guidelines skill serves as a comprehensive operational template for engineering teams to standardize development across production-grade software projects. Inspired by real-world platforms like Zenith, this skill encapsulates essential project-specific knowledge including architecture, stack configuration, file structure conventions, and standardized coding patterns. It acts as a baseline to ensure team alignment, consistency in code quality, and adherence to established best practices during the development lifecycle.

• Standardized Technology Stack: Includes setup guidance for Next.js 15, FastAPI, Supabase, and Claude API integration.

• Operational Architecture: Clearly defines service-oriented diagrams and communication flows between front-end and back-end services.

• Coding Standards: Provides concrete implementation templates for API responses, frontend API calling, and structured AI response handling using Pydantic and TypeScript.

• Automated Testing & Deployment: Contains built-in test suite commands for pytest, Playwright, and React Testing Library, along with checklists for production-ready deployments via Google Cloud Run.

• Ideal for developers needing to jumpstart new repositories with battle-tested patterns.

• Enforces strict coding constraints: zero-emoji policy, TDD-first approach, 80% coverage requirements, and modular file organization.

• Inputs expected: Project requirements and technical stack decisions; Outputs provided: Structural templates, configuration scripts, and documentation best practices.

• Constraints: Follows immutability rules and discourages console.log in production, ensuring clean and maintainable codebases.

• Keywords: Software architecture, FastAPI, Next.js 15, Pydantic, TypeScript, CI/CD, production engineering, code standards, automated testing.