conventions

Document shared conventions for a Next.js and FastAPI monorepo.

Updated Nov 27, 2025

Search Tags:#code quality #testing #architecture #fastapi #standards #conventions #nextjs

Ready to run

npx skills add https://github.com/wtsi-hgi/llm-knowledge-base --skill conventions-wtsi-hgi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: conventions
Source: https://github.com/wtsi-hgi/llm-knowledge-base/tree/main/.github/skills/conventions
Command: npx skills add https://github.com/wtsi-hgi/llm-knowledge-base --skill conventions-wtsi-hgi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a single source of truth for project architecture, code quality, and testing standards, ensuring consistency and maintainability across the development team.

Core Features & Use Cases

Defines Project Stack: Clearly outlines the frontend (Next.js) and backend (FastAPI) technologies used.
Enforces Architecture Principles: Details patterns like BFF, type safety with Zod, and Server/Client component usage.
Sets Code Quality Standards: Provides specific guidelines for Python and TypeScript code.
Standardizes Testing: Outlines testing strategies for both backend (pytest) and frontend (Vitest).
Use Case: New developers can quickly onboard by understanding the project's established best practices, and code reviewers can ensure adherence to these standards.

Quick Start

Refer to the conventions skill for project-wide standards.

Frequently Asked Questions about conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I standardize code quality and architecture conventions for a Next.js and FastAPI monorepo?▼

To standardize code quality and architecture conventions for a Next.js and FastAPI monorepo, document shared standards covering stack details, BFF patterns, Zod type contracts, and specific Python and TypeScript guidelines to ensure team consistency.

What testing patterns should I use for a full-stack Python and TypeScript project?▼

For a full-stack Python and TypeScript project, testing patterns should standardize on pytest for the FastAPI backend and Vitest for the Next.js frontend, ensuring consistent validation across both ends.

How does a BFF architecture work with Next.js and FastAPI?▼

A BFF architecture with Next.js and FastAPI uses the frontend as a Backend-for-Frontend layer, enforcing type safety through Zod contracts and defining Server and Client component usage to streamline data fetching.

What are the best practices for maintaining type safety across Python and TypeScript codebases?▼

Best practices for maintaining type safety across Python and TypeScript codebases involve enforcing Zod contracts for data boundaries and establishing specific code quality standards to maintain architectural consistency.

How can code reviewers ensure consistency in a monorepo with multiple frameworks?▼

Code reviewers can ensure consistency in a monorepo with multiple frameworks by referencing documented project conventions that outline architectural principles, language-specific standards, and testing patterns for Python and TypeScript.