FM-11 Contributing
FM-11 // COMMUNITY

Contributing

Updated Jan 15, 2025 · Contributors: nikhil
Table of Contents

Welcome

If you’re reading this, you’re interested in contributing to Future AGI. Thank you. Open source contributions are the backbone of our ecosystem, and we take every contribution seriously.

Where to Start

Good First Issues

Look for issues labeled good first issue in any of our repos. These are intentionally scoped, well-documented, and ideal for getting familiar with the codebase.

Documentation

Docs improvements are always welcome - typo fixes, better examples, missing guides. Don’t underestimate the impact: a good doc fix can save hundreds of developers hours.

Bug Reports

Found a bug? File an issue with:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • Your environment (OS, Python/Node version, SDK version)

A well-written bug report is itself a valuable contribution.

Development Setup

Python SDK

git clone https://github.com/futureagi/futureagi-python
cd futureagi-python
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest

TypeScript SDK

git clone https://github.com/futureagi/futureagi-js
cd futureagi-js
npm install
npm test

Pull Request Guidelines

Before You Start

  • Check if there’s an existing issue or discussion about the change
  • For large changes, open an issue first to discuss the approach
  • Don’t surprise us with a 2,000-line PR - talk to us early

Writing the Code

  • Follow the existing code style (linters enforce most of this)
  • Write tests for new functionality
  • Update docs if behavior changes
  • Keep commits clean and atomic

Writing the PR Description

Your PR description should explain:

  • What changed (a brief summary)
  • Why it changed (the problem it solves)
  • How to test it (steps for reviewers)
  • Screenshots if there are visual changes

Review Process

  1. A maintainer will review your PR within 3 business days
  2. We may request changes - this is normal and not a rejection
  3. Once approved, a maintainer merges the PR
  4. You’ll be added to the contributors list

Contributor License Agreement

For contributions beyond typo fixes, we ask you to sign a CLA. This protects both you and us by ensuring contributions can be legally distributed. The CLA bot will comment on your first PR with instructions.

Recognition

All contributors are credited in release notes and on our website. Significant contributors may be invited to join our contributor program with:

  • Early access to new features
  • Direct line to the engineering team
  • Swag (if you want it)
  • Speaking opportunities at community events