Skip to content

Project Structure

This document explains the repository layout so you can find what you need quickly.

.
├── .cursorrules # Cursor AI configuration
├── .cursor/
│ └── commands/ # Cursor custom slash commands
│ ├── pr.md # /pr — generate a pull request
│ ├── review.md # /review — code review
│ └── address_feedback.md # /address_feedback — resolve PR comments
├── .gemini/ # Gemini CLI configuration
│ ├── GEMINI.md # Repository intelligence for AI agents
│ └── settings.json # Gemini CLI settings
├── Makefile # Automation targets
├── README.md # Repository overview
├── standards/ # All standards documents
│ ├── architecture/ # Architecture and automation standards
│ │ ├── 00_project_standards_and_architecture.md
│ │ ├── 01_automation_standards.md
│ │ └── 02_cursor_automation_standards.md
│ │
│ ├── languages/ # Language-specific standards
│ │ ├── 03_python_standards.md
│ │ ├── 04_java_standards.md
│ │ ├── 05_kotlin_standards.md
│ │ ├── 06_swift_standards.md
│ │ ├── 07_dart_standards.md
│ │ ├── 08_typescript_standards.md
│ │ ├── 09_javascript_standards.md
│ │ ├── 10_rust_standards.md
│ │ └── 11_zig_standards.md
│ │
│ ├── process/ # Process and workflow standards
│ │ ├── 12_documentation_standards.md
│ │ ├── 13_git_version_control_standards.md
│ │ └── 14_code_review_expectations.md
│ │
│ ├── shared/ # Shared standards for all agents
│ │ └── core-standards.md
│ │
│ └── agents/ # AI agent configuration templates
│ ├── copilot/
│ │ └── .github/
│ │ └── copilot-instructions.md
│ ├── aider/
│ │ └── .aiderrc
│ └── codex/
│ └── .codexrc
├── scripts/ # Automation scripts
│ ├── setup.sh # First-time project setup
│ ├── sync-standards.sh # Pull latest standards
│ ├── setup-git-aliases.sh # Configure git aliases
│ ├── add-copilot-instructions-pr.sh # PR to add Copilot instructions
│ ├── fetch-pr-comments.sh # Fetch unresolved PR comments
│ └── generate-pr-content.sh # Generate PR title and body
└── docs/ # Documentation
├── getting-started/
│ ├── quick-start.md
│ ├── installation.md
│ └── project-structure.md # This file
├── guides/
│ ├── multi-agent-setup.md
│ ├── ci-cd-integration.md
│ ├── customization.md
│ └── cursor-commands.md
├── reference/
│ ├── makefile-targets.md
│ ├── scripts.md
│ └── agent-configs.md
├── changelog.md
└── plans/ # Internal planning documents

Standards are organized by category so you only look at what applies:

CategoryPathContent
Architecturestandards/architecture/Clean Architecture, automation, Cursor integration
Languagesstandards/languages/Python, Java, Kotlin, Swift, Dart, TypeScript, JavaScript, Rust, Zig
Processstandards/process/Documentation, git workflow, code review
Sharedstandards/shared/Core standards that apply across all agents
Agent configsstandards/agents/Templates for each AI agent

Adding support for a new language means creating one file in standards/languages/. Adding a new AI agent means creating a directory under standards/agents/ and updating the setup script.

  • Standards live in standards/ and describe what to do.
  • Scripts live in scripts/ and handle how to automate it.
  • Docs live in docs/ and explain why and how to get started.

The .cursorrules file and all agent configs reference standards using paths relative to the repository root, for example:

  • standards/architecture/00_project_standards_and_architecture.md
  • standards/languages/03_python_standards.md
  • standards/shared/core-standards.md

Scripts in scripts/ auto-detect whether they are running inside the standards repo or inside a project that uses it as a submodule, and adjust paths accordingly.