Contributing

AgentFlow is open source and we welcome contributions. Here's everything you need to get started.

Prerequisites

You'll need the following tools installed:

  • Rust (stable) — rustup install stable
  • Node.js 20+ — for the React frontend
  • Tauri CLI — cargo install tauri-cli
  • Claude Code CLI — for testing pipeline execution

Development Setup

Terminal
bash
# Clone the repository
git clone https://github.com/jadessoriano/agent-flow.git
cd agent-flow

# Install frontend dependencies
npm install

# Start development (opens the app with hot-reload)
cargo tauri dev

First build

The first cargo tauri dev will compile the Rust backend from scratch, which may take a few minutes. Subsequent builds are incremental and much faster.

Project Structure

Project Layout
text
agent-flow/
├── src/                 # React frontend (TypeScript)
│   ├── components/      # UI components
│   ├── stores/          # Zustand state management
│   ├── hooks/           # Custom React hooks
│   └── types/           # TypeScript type definitions
├── src-tauri/           # Rust backend
│   ├── src/
│   │   ├── executor/    # Pipeline execution engine
│   │   ├── commands/    # Tauri IPC command handlers
│   │   └── db/          # SQLite database layer
│   └── Cargo.toml
├── public/              # Static assets
└── package.json

Pull Request Guidelines

  • Branch from main — create a feature branch like feat/your-feature or fix/bug-description
  • Keep PRs focused — one feature or fix per PR
  • Write descriptive commits — use conventional commit format (e.g., feat: add node copy/paste)
  • Test your changes — run npm run lint and cargo clippy before submitting
  • Update docs if your changes affect user-facing behavior

Reporting Issues

Found a bug or have a feature request? Open an issue on GitHub Issues. Please include:

  • AgentFlow version and OS
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Screenshots or error logs if applicable

Good first issues

Look for issues tagged good first issue on GitHub — these are great starting points for new contributors.

License

AgentFlow is released under the MIT License. By contributing, you agree that your contributions will be licensed under the same terms.

Previous

FAQ