Skip to main content
Fork the repo, make your change on a branch, and open a pull request for review.
Before writing or editing any documentation page, read the 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

1

Create a virtual environment

2

Install platform test extras

This installs every dependency needed for pytest collection and execution — including email-validator for Pydantic EmailStr fields. No manual follow-up installs.
3

Run tests

​
How It Works

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

​
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 before editing any page.
Install the test extras and run pytest before opening a PR to catch failures early.

Documentation Style Guide

Structure and rules for docs pages.

Installation

Set up a local development environment.