title	Contributing
sidebarTitle	Contributing
description	Guide for contributing to PraisonAI through GitHub, including forking, cloning, and submitting pull requests
icon	code-branch

Fork the repo, make your change on a branch, and open a pull request for review.

git clone https://github.com/yourusername/praisonAI.git
git checkout -b new-feature
git commit -am "Add some feature"
git push origin new-feature

graph LR
    subgraph "Contribution Flow"
        Fork[📋 Fork] --> Branch[🤖 Branch]
        Branch --> PR[🧠 Pull Request]
        PR --> Merge[✅ Merged]
    end

    classDef input fill:#8B0000,stroke:#7C90A0,color:#fff
    classDef process fill:#189AB4,stroke:#7C90A0,color:#fff
    classDef output fill:#10B981,stroke:#7C90A0,color:#fff

    class Fork,Branch input
    class PR process
    class Merge output

Loading

Before writing or editing any documentation page, read the [Documentation Style Guide](/docs/guides/documentation-style-guide) — it defines the page structure, components, Mermaid colour scheme, and writing rules every page must follow.

• Fork on GitHub: Use the "Fork" button on the repository page.
• Clone your fork: git clone https://github.com/yourusername/praisonAI.git
• Create a branch: git checkout -b new-feature
• Make changes and commit: git commit -am "Add some feature"
• Push to your fork: git push origin new-feature
• Submit a pull request via GitHub's web interface.
• Await feedback from project maintainers.

Running Platform Tests

```bash python -m venv .venv && source .venv/bin/activate # Windows: .venv\Scripts\activate ``` ```bash pip install -e src/praisonai-platform[test] ``` This installs every dependency needed for pytest collection and execution — including `email-validator` for Pydantic `EmailStr` fields. No manual follow-up installs. ```bash pytest src/praisonai-platform/tests -q ```

How It Works

You open a pull request, maintainers review it, and once approved it merges into the main branch.

sequenceDiagram
    participant Contributor
    participant GitHub
    participant Maintainer

    Contributor->>GitHub: Push branch and open PR
    GitHub->>Maintainer: Request review
    Maintainer-->>Contributor: Feedback or approval
    Contributor->>GitHub: Address feedback, PR merges

Loading

Best Practices

Create a focused branch (`git checkout -b new-feature`) for each contribution so reviews stay small and clear. For docs changes, follow the [Documentation Style Guide](/docs/guides/documentation-style-guide) before editing any page. Install the test extras and run `pytest` before opening a PR to catch failures early.

Related

Structure and rules for docs pages. Set up a local development environment.