docs: improve documentation and add examples#1640
docs: improve documentation and add examples#1640AkhiChalasani wants to merge 1 commit intoMervinPraison:mainfrom
Conversation
Created CONTRIBUTING.md
ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one. |
📝 WalkthroughWalkthroughThis pull request adds a new ChangesContributor Guidelines
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@copilot Do a thorough review of this PR. Read ALL existing reviewer comments above from Qodo, Coderabbit, and Gemini first — incorporate their findings. Review areas:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new CONTRIBUTING.md file to provide guidance for new contributors. The review feedback suggests enhancing the document by adding specific steps for cloning and installing dependencies, explicitly mentioning PEP 8 as the required code style, and providing instructions on how to run tests using pytest.
| 1. Fork the repository | ||
| 2. Create a feature branch | ||
| 3. Make your changes | ||
| 4. Submit a pull request |
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
Specifying the code style (e.g., PEP 8 for Python) provides clearer guidance for contributors to maintain consistency.
| - Follow existing code style | |
| - Follow existing code style (PEP 8) |
| ## Guidelines | ||
|
|
||
| - Follow existing code style | ||
| - Add tests for new features |
There was a problem hiding this comment.
Mentioning how to run tests (e.g., using pytest) helps contributors verify their changes locally before submission.
| - Add tests for new features | |
| - Add tests for new features and run them locally using pytest |
Greptile SummaryThis PR adds a new
Confidence Score: 4/5This is a documentation-only addition with no code changes; it is safe to merge as-is, though the content is quite minimal. The change adds a new markdown file with no executable code, so there is no risk of regressions or broken behavior. The only concern is that the contributing guide omits setup instructions, test commands, and commit conventions that would make it genuinely useful to new contributors. CONTRIBUTING.md could benefit from additional content before being considered a complete guide. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A([Contributor]) --> B[Fork Repository]
B --> C[Create Feature Branch]
C --> D[Make Changes]
D --> E{Follow Guidelines?}
E -- Yes --> F[Submit Pull Request]
E -- No --> D
F --> G[Review & Merge]
Reviews (1): Last reviewed commit: "docs: improve documentation" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| # 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 | ||
|
|
||
| ## Guidelines | ||
|
|
||
| - Follow existing code style | ||
| - Add tests for new features | ||
| - Update documentation as needed |
There was a problem hiding this comment.
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.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
10-14: ⚡ Quick winConsider adding a link to the issue tracker or discussions.
To help new contributors get started and ask questions, you might want to add a bullet point linking to GitHub Issues or Discussions. For example:
- "Check existing issues or open a new one to discuss your idea"
This would be a quick addition that helps contributors engage with the community.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTRIBUTING.md` around lines 10 - 14, Add a new bullet under the "## Guidelines" section in CONTRIBUTING.md that directs contributors to check or open issues/discussions on the repo (for example: "Check existing issues or open a new one to discuss your idea"); ensure the link points to the project's Issues or Discussions page and follow the existing bullet style so it integrates with the existing items "- Follow existing code style", "- Add tests for new features", "- Update documentation as needed".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 10-14: Add a new bullet under the "## Guidelines" section in
CONTRIBUTING.md that directs contributors to check or open issues/discussions on
the repo (for example: "Check existing issues or open a new one to discuss your
idea"); ensure the link points to the project's Issues or Discussions page and
follow the existing bullet style so it integrates with the existing items "-
Follow existing code style", "- Add tests for new features", "- Update
documentation as needed".
|
@claude You are the FINAL architecture reviewer. If the branch is under MervinPraison/PraisonAI (not a fork), you are able to make modifications to this branch and push directly. SCOPE: Focus ONLY on Python packages (praisonaiagents, praisonai). Do NOT modify praisonai-rust or praisonai-ts. Read ALL comments above from Gemini, Qodo, CodeRabbit, and Copilot carefully before responding. Phase 1: Review per AGENTS.md
Phase 2: FIX Valid Issues Phase 3: Final Verdict |
|
Claude finished @MervinPraison's task —— View job Final Architecture Review ✅Tasks:
Phase 1: Architecture Review ✅
Phase 2: Issues Fixed ✅ Enhanced CONTRIBUTING.md addressing ALL valid reviewer feedback:
Files Modified:
What Was Skipped:
Phase 3: Final Verdict ✅ ✅ APPROVED - All valid architectural and documentation issues have been resolved. The enhanced CONTRIBUTING.md now provides clear, actionable guidance for new contributors with proper setup instructions, testing commands, and development workflows. Branch: improve/docs-0509 | Job Run |
2 participants
Summary
Summary by CodeRabbit