Contributing to AgentBridge

March 30, 2025 · View on GitHub

Thank you for your interest in contributing to AgentBridge! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

Please read and follow our Code of Conduct to help us maintain a healthy and welcoming community.

Project Structure

AgentBridge is organized as a monorepo with the following structure:

packages/
├── core/                 # Core library
├── frameworks/           # Framework adapters
│   ├── react/            # React SDK
│   ├── angular/          # Angular SDK 
│   ├── react-native/     # React Native SDK
│   └── flutter/          # Flutter SDK
├── providers/            # Communication providers
│   ├── ably/             # Ably implementation
│   ├── firebase/         # Firebase implementation
│   ├── pusher/           # Pusher implementation
│   └── supabase/         # Supabase implementation
├── communication/        # Communication protocols
│   └── websocket/        # WebSocket implementation
└── server/               # Server components

Development Setup

Fork and clone the repository

git clone https://github.com/YOUR_USERNAME/agentbridge.git
cd agentbridge

Install dependencies
```
npm install
```
Build the packages
```
npm run build
```
Run tests
```
npm run test
```

Development Workflow

Create a new branch for your feature or bugfix

git checkout -b feature/your-feature-name

Make your changes

Implement your feature or bugfix.
Run linting and tests
```
npm run lint
npm run test
```
Build the packages to ensure everything compiles
```
npm run build
```
Commit your changes using conventional commits
```
git commit -m "feat: add new feature"
```
We follow the Conventional Commits specification.
Push your branch and create a pull request
```
git push origin feature/your-feature-name
```
Then go to GitHub and create a pull request against the main branch.

Working with Packages

Creating a New Package

Run the placeholder generator to create a starting structure:
```
node scripts/generate-placeholders.js
```
Implement the required functionality for your package.
Update the root package.json if necessary.

Testing Changes Across Packages

Since packages depend on each other, you may need to test changes across multiple packages. The best way to do this is to use the workspace feature:

npm run build  # Build all packages

Pull Request Process

Ensure your code passes all tests and linting.
Update documentation if necessary.
Add tests for new functionality.
Make sure your PR description clearly describes the problem and solution.
Request a review from at least one of the maintainers.

Release Process

Releases are managed by the maintainers. If you'd like to request a release, please open an issue.

The release process involves:

Preparing packages with version updates
```
npm run prepare-publish
```
Publishing packages to npm
```
npm run publish-packages
```

Reporting Bugs

Please report bugs by opening a new issue on GitHub. Include as much information as possible:

Package version
Platform/OS
Reproduction steps
Expected vs actual behavior
Code examples if possible

Suggesting Features

We welcome feature suggestions! Please open an issue describing your proposed feature, why it's valuable, and how it should work.

License

By contributing to AgentBridge, you agree that your contributions will be licensed under the project's MIT License.