Engineering

Coding Conventions for AI

Tell AI your code style once. List the stack and the engine returns the naming rules and conventions it implies — plus your own house rules carried verbatim.

Overview

AI writes plausible code that quietly ignores your conventions — class components in a hooks codebase, hard-coded colors in a tokenized design system. This setup captures the conventions for Atlas UI, a shared React component library, where a breaking change ripples across every product team. You list the house rules (additive props, tokens not hard-coded values); the engine adds the React, TypeScript, and Vitest conventions and naming rules automatically. The AI stops guessing your style and starts following it.

Workflow

List the stack
React, TypeScript, Vitest — each maps to known naming and convention rules.
Add your house rules
Additive props, tokens over hard-coded values; these travel verbatim.
Hand the AI the conventions
It writes code that matches the codebase instead of generic defaults.

Why This Works

Stack detection means you list "TypeScript" and get "no any, strict mode on" for free
Your own conventions are carried word-for-word, never paraphrased
A design-system library is exactly where convention drift causes the most damage

Best for

Shared libraries and design systems
Teams with a documented style guide
Codebases AI keeps writing against the grain of

Not for

Reviewing a specific diff against the rules — use the Code Review Prompt Generator
Defining a reviewer persona — use the System Prompt Generator

Use cases

Shared libraries and design systems
Teams with a documented style guide
Codebases AI keeps writing against the grain of

Customize This Resource

Opens this project in Project Context Builder. Build to get the full context profile — then adjust the mode, stack, glossary, and output target.

Open in Project Context Builder

Prompt Template

# Project Context: Atlas UI

> Save this at your repo root as `.cursorrules` (or `.cursor/rules/project.mdc`) so Cursor loads it for every request.

## Project Overview
Atlas UI is a shared React component library used by every product team in the company. Changes ripple across many apps, so backward compatibility is critical.

## Core Facts
- Project type: Software Project
- Primary stack: React, TypeScript, Vitest, Storybook
- This is a software codebase — correctness, readability, and maintainability come before cleverness.

## Tech Stack
- React
- TypeScript
- Vitest
- Storybook

## Team Conventions
- Every component ships with stories and accessibility tests.
- Props are additive — never rename or remove a prop without a major version.
- Design tokens come from the theme, never hard-coded values.
- Function components with hooks only — no class components; keep components pure and side effects in effects. (React)
- No `any` — prefer `unknown` with narrowing; keep `strict` mode on and types honest. (TypeScript)
- Keep tests fast and isolated; use fake timers for time-dependent code. (Vitest)

## Naming Rules
- camelCase for variables and functions, PascalCase for types and components. (TypeScript)

## Architecture Principles
- Keep modules focused — a file or function should do one thing well.
- Prefer clarity over abstraction; introduce indirection only when duplication has actually appeared.
- Changes should come with the test that proves them.

## Glossary
- **Token** — a named design value (color, spacing, radius) from the theme.
- **Variant** — a named visual style of a component.
- **Slot** — a named insertion point for consumer content.

## Always Remember
- This library is consumed by many apps — a breaking change is a company-wide event.
- This profile is the source of truth for project facts — prefer it over general assumptions.

## Never Assume
- Do not hard-code colors or spacing — read them from design tokens.
- Do not assume a component is class-based — the codebase uses function components and hooks.
- Do not assume a value's type — check the type definition before changing a signature.
- Do not assume how a module is used elsewhere — check the call sites before changing a signature.
- When a fact is missing from this profile, ask — do not invent it.

## AI Usage Notes
- Cursor reads project rules from the repo, so this travels with the code and every teammate gets the same context.
- This profile is project KNOWLEDGE, not behavior — for a task persona (role, tone, escalation rules), build a System Prompt in the System Prompt Generator.
- It is durable project identity, not work state — to continue an in-progress task in a new chat, use the Context Handoff Builder.
- Profile completeness: 100/100 (Complete) — bracketed gaps, if any, mark missing info that was never invented.

Related Resources

Explore more resources that work well with this one.