Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (53 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 1.83 KB
Raw

Contributing to claude-code-agents-ui

Originally created by @davidrodriguezpozo.
This project is a fork of agents-ui.This project is now maintained and improved with contributions from the community.

Thank you for your interest in contributing to claude-code-agents-ui! We’re excited to have you here. This guide will help you get up and running quickly.

🚀 Development Setup

  1. Clone the repository
   git clone https://github.com/Ngxba/claude-code-agents-ui.git
   cd claude-code-agents-ui

  1. Install dependencies

    bun install

  2. Start the development server

    bun run dev

  3. Open the app

    http://localhost:3030

🛠️ Making Changes

  1. Fork the repository and create a new branch from main

  2. Implement your changes

  3. Test your changes locally:

    bun run dev

  4. Run type checks:

    bun run typecheck

  5. Submit a pull request with a clear description of your changes

💡 What Can You Work On?

  • Browse the issues and look for labels like good first issue
  • Have a new idea? Open an issue first so we can discuss it before implementation

🎨 Code Style Guidelines

To keep the codebase consistent and maintainable:

  • Use Vue 3 Composition API with <script setup>
  • Write all new code in TypeScript
  • Use Tailwind CSS for styling (prefer Nuxt UI components when applicable)
  • Extract reusable logic into composables (app/composables/)

❓ Need Help?

If you have any questions or need guidance:

  • Open an issue
  • Start a discussion

We’re happy to support you—contributions of all sizes are welcome!