← Back to Home

Documentation

All documentation is available on GitHub. Click "View" to read or "Raw" to download.

Getting Started

README

Overview of the AI coding standards system, structure, and how to use it.

General Instructions

Core principles and guidelines that apply to all languages and frameworks.

Editor Setup

LazyVim & VSCode

Complete editor configuration for LazyVim (preferred) and VSCode, including keybindings, plugins, and language-specific setup.

Language-Specific Patterns

Go

Accept interfaces, return concrete types. Functional options. Table-driven tests. Context-aware functions.

Python

Mandatory type hints (mypy strict). Use uv for package management. Pydantic for validation. Async/await patterns.

TypeScript/Vue

Composition API with <script setup>. Strict TypeScript mode. Explicit type annotations. Composables.

PowerShell

Multi-subscription operations by default. Prefer Azure Resource Graph over loops. Session validation. Graph API patterns.

Bash

Shellcheck validation. Proper error handling with set -euo pipefail. Robust scripting patterns.

AI Prompts

Prompts Overview

Guide to using prompt templates with AI coding assistants.

Code Review

Templates for reviewing code against standards.

Refactoring

Templates for refactoring code to meet standards.

New Feature

Templates for implementing new features.

Debugging

Templates for debugging issues with AI assistance.

Configuration Files

.aiignore

Files and directories to exclude from AI context.