Skip to content

docs: improve documentation and add examples #1640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AkhiChalasani wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve documentation and add examples #1640

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing to PraisonAI

Thank you for your interest! Here's how to get started:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request
Comment on lines +5 to +8
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The 'how to get started' section is missing essential steps for cloning the repository and installing dependencies. Adding these steps helps new contributors set up their environment correctly.

Suggested change
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request
1. Fork the repository
2. Clone your fork and install dependencies: pip install -e .
3. Create a feature branch
4. Make your changes
5. Submit a pull request


## Guidelines

- Follow existing code style
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Specifying the code style (e.g., PEP 8 for Python) provides clearer guidance for contributors to maintain consistency.

Suggested change
- Follow existing code style
- Follow existing code style (PEP 8)

- Add tests for new features
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Mentioning how to run tests (e.g., using pytest) helps contributors verify their changes locally before submission.

Suggested change
- Add tests for new features
- Add tests for new features and run them locally using pytest

- Update documentation as needed
Comment on lines +1 to +14
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing dev-setup, test, and commit-convention sections

The guide skips the information contributors most often need: how to install dependencies and set up a local dev environment, what command to run to execute the test suite, and any commit message or branch-naming conventions expected by the project. Without these, a first-time contributor will hit friction before they can even verify their change is correct, which is exactly the situation a CONTRIBUTING file should prevent.