code

name	code
description	Code generation guidelines for this project. Use when writing code, functions, or classes. Enforces English naming, concise comments, and project conventions.
metadata	{"author":"Alexandre Roman","version":"1.0"}

Code Generation

Guidelines for writing code in this project.

Language Rules

IMPORTANT: Always use English for all code elements:

• Variable names
• Function names
• Class names
• Comments
• Error messages
• Log messages
• String literals (user-facing text)

Code Comments

Comments should be:

• Concise: Short and to the point
• Explanatory: Explain "why", not "what"
• English: Always in English

Good Comments

// Retry with exponential backoff to handle temporary network failures
const result = await retryWithBackoff(fetchData);

// Points are based on lifetime earned, not current balance
// This ensures level never decreases even after spending
const level = calculateLevel(totalPointsEarned);

Bad Comments

// Fetch the data
const data = fetchData();

// Add 1 to counter
counter++;

// Loop through items
for (const item of items) { ... }

Project Context

This is a demonstration project for Temporal workflow patterns.

See specifications in specs/ for:

• Domain model: specs/domain.md
• Workflow patterns: specs/workflow.md
• API contracts: specs/api.md
• Architecture: specs/architecture.md