Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
152 lines (111 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

152 lines (111 loc) · 3.36 KB

Contributing to Agent Deck

Thank you for your interest in contributing to Agent Deck! This document provides guidelines and information for contributors.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/agent-deck.git
cd agent-deck
  3. Add upstream remote: 
    git remote add upstream https://github.com/asheshgoplani/agent-deck.git

Development Setup

Prerequisites

  • Go 1.24 or later (or Go 1.21+ with automatic toolchain download)
  • tmux
  • Make

Building

make build      # Build binary to ./build/agent-deck
make test       # Run tests
make lint       # Run linter (requires golangci-lint)
make fmt        # Format code

Running Locally

make dev        # Run with auto-reload (requires 'air')
# or
make run        # Run directly

Making Changes

Branch Naming

  • feature/description - New features
  • fix/description - Bug fixes
  • perf/description - Performance optimizations
  • docs/description - Documentation changes
  • refactor/description - Code refactoring

Commit Messages

Use clear, descriptive commit messages:

feat: add support for custom commands
fix: resolve status detection for OpenCode
docs: update installation instructions
refactor: simplify group management logic

Code Style

  • Run make fmt before committing
  • Run make lint to check for issues
  • Follow existing code patterns
  • Add tests for new functionality

Pull Request Process

  1. Create a feature branch from main:

    git checkout -b feature/my-feature

  2. Make your changes and commit them

  3. Keep your branch updated:

    git fetch upstream
git rebase upstream/main

  4. Push to your fork:

    git push origin feature/my-feature

  5. Open a Pull Request on GitHub

PR Guidelines

  • Provide a clear description of the changes
  • Reference any related issues
  • Ensure all tests pass
  • Update documentation if needed

Reporting Issues

Bug Reports

Include:

  • Agent Deck version (agent-deck version)
  • Operating system and version
  • tmux version (tmux -V)
  • Steps to reproduce
  • Expected vs actual behavior
  • Any error messages or logs

Feature Requests

  • Describe the use case
  • Explain why existing features don't solve it
  • Provide examples if possible

Project Structure

agent-deck/
├── cmd/agent-deck/     # CLI entry point
├── internal/
│   ├── ui/             # TUI components (Bubble Tea)
│   ├── session/        # Session & group management
│   └── tmux/           # tmux integration, status detection
├── .github/workflows/  # CI/CD
├── Makefile           # Build automation
└── README.md

Testing

  • Add tests for new functionality
  • Run the full test suite: make test
  • Tests should be deterministic and not depend on external state

Debug Mode

Enable debug logging:

AGENTDECK_DEBUG=1 agent-deck

Questions?

License

By contributing, you agree that your contributions will be licensed under the MIT License.