Contributing to AUI

Contributing to AUI

Thank you for your interest in contributing to AUI (Agent UI). We welcome contributions of all kinds -- bug reports, feature suggestions, documentation improvements, and code changes. Every contribution helps make AUI a better tool for visually managing Claude Code agent teams.

Table of Contents

• How to Report Bugs
• How to Suggest Features
• Development Setup
• Project Structure
• Code Style
• Pull Request Process
• Code of Conduct

How to Report Bugs

If you encounter a bug, please open a GitHub Issue and include the following:

• Summary: A clear, concise description of the problem.
• Steps to Reproduce: A numbered list of steps that reliably trigger the issue.
• Expected Behavior: What you expected to happen.
• Actual Behavior: What actually happened, including any error messages or screenshots.
• Environment: Your operating system, Node.js version, Rust toolchain version, and AUI version.

Search existing issues before opening a new one to avoid duplicates. If you find a matching issue, add a comment with any additional context you can provide.

How to Suggest Features

Feature requests are welcome. Please open a GitHub Issue with the following:

• Problem Statement: Describe the problem or workflow gap the feature would address.
• Proposed Solution: Outline how you envision the feature working.
• Alternatives Considered: Note any alternative approaches you have thought about.
• Additional Context: Include mockups, screenshots, or references if applicable.

Label your issue with `enhancement` if your repository supports it.

Development Setup

Prerequisites

Make sure you have the following installed:

• Node.js (v18 or later)
• pnpm (v8 or later)
• Rust toolchain (stable, via rustup)
• Tauri v2 system dependencies -- see the Tauri prerequisites guide for your platform

Getting Started

1. **Fork** the repository on GitHub.

2. **Clone** your fork locally:

   git clone https://github.com//aui.git
   cd aui

3. **Install dependencies**:

   pnpm install

4. **Run the full desktop app** (Tauri + React):

   pnpm tauri dev

   This compiles the Rust backend and launches the desktop window with hot-reloading for the frontend.

5. **Run frontend-only development** (no Tauri/Rust required):

   pnpm dev

   This starts the Vite development server. Useful for working on UI components and layout without needing the Rust toolchain. Note that Tauri-specific APIs (filesystem, shell, dialogs) will not be available in this mode.

Project Structure

aui/
  src/
    components/    # React components (pages, panels, modals, shared UI)
    store/