project-guidelines-example_skill

Overview

This skill is a project-specific guideline template modeled on a production application. It captures architecture, file layout, code patterns, testing, deployment steps, and critical rules to keep a codebase consistent and deployable. Use it as a concrete blueprint to onboard engineers and standardize implementation choices across frontend, backend, and AI integration.

How this skill works

The skill documents what to inspect and enforce: tech stack choices, folder structure, API response contracts, custom hooks, and Claude/Anthropic integration patterns. It outlines test suites and commands for running frontend and backend tests, plus a pre-deployment checklist and commands for building and deploying services. It also lists critical team rules and environment variable expectations to prevent common operational errors.

When to use it

• Onboard new engineers to the project and its conventions
• Set up CI/CD and verify deployment readiness
• Write or review API contracts and structured AI tool output
• Create tests and enforce the required coverage and TDD workflow
• Prepare releases and validate environment variable configuration

Best practices

• Follow defined tech stack and architecture to reduce drift between services
• Use ApiResponse patterns on both backend and frontend for consistent error handling
• Write tests first (TDD), aim for ≥80% coverage, and include E2E tests
• Avoid hardcoded secrets; document and require environment variables
• Maintain immutability, strong input validation (Pydantic/Zod), and proper try/catch error handling

Example use cases

• Create a new FastAPI route following ApiResponse and Pydantic model patterns
• Implement a frontend data hook using the provided useApi structure
• Integrate Claude tool-calling with a typed structured output model
• Run and verify tests locally before deployment with provided commands
• Execute the pre-deployment checklist and deploy frontend/backend to Cloud Run