fix: update workspace count from 4 to 6 packages in CONTRIBUTING.md - #6729
fix: update workspace count from 4 to 6 packages in CONTRIBUTING.md#6729haroldfabla2-hue wants to merge 1 commit into
Conversation
Fixes crewAIInc#6664 - Incorrect number of workspaces in CONTRIBUTING.md The pyproject.toml defines 6 workspace members but the docs only listed 4. This change updates the count and adds the missing packages (cli, crewai-core) to the table.
📝 WalkthroughWalkthroughUpdated ChangesWorkspace Documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In @.github/CONTRIBUTING.md:
- Line 40: Update the cli entry in the contribution guide’s component table to
describe it as “CLI” rather than “CLI interface,” leaving the path and other
entries unchanged.
- Around line 32-41: Reconcile the six-package table in the “uv workspace”
section with the actual workspace configuration: either add valid package
manifests for lib/cli and lib/crewai-core, include them in pyproject.toml
workspace members, and regenerate uv.lock, or remove those two entries so the
table lists only the four managed packages.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 758b282a-78c1-4ecb-be1b-3b491274f32c
📒 Files selected for processing (1)
.github/CONTRIBUTING.md
| This is a uv workspace with six packages under `lib/`: | ||
|
|
||
| | Package | Path | Description | | ||
| |---------|------|-------------| | ||
| | `crewai` | `lib/crewai/` | Core framework | | ||
| | `crewai-tools` | `lib/crewai-tools/` | Tool integrations | | ||
| | `crewai-files` | `lib/crewai-files/` | File handling | | ||
| | `devtools` | `lib/devtools/` | Internal release tooling | | ||
| | `cli` | `lib/cli/` | CLI interface | | ||
| | `crewai-core` | `lib/crewai-core/` | Core agents architecture | |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift
🧩 Analysis chain
🏁 Script executed:
rg -n -A8 -B2 'tool\.uv\.workspace|members\s*=' pyproject.toml uv.lockRepository: crewAIInc/crewAI
Length of output: 871
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== file existence and pyproject membership paths =="
for p in lib/cli/pyproject.toml lib/cli/pyproject.toml lib/cli/pyproject.toml lib/crewai-core/pyproject.toml lib/cli/pyproject.toml lib/crewai-core/pyproject.toml; do
: # placeholder
done
git ls-files | rg '(^|/)pyproject\.toml$|(^|/)uv\.(lock|toml)$|^lib/(cli|crewai-core)/' | sed -n '1,200p'
echo
echo "== pyproject metadata for candidate packages =="
python3 - <<'PY'
import pathlib, re, tomllib, json, subprocess, sys
root=pathlib.Path('.')
for p in sorted(root.rglob('pyproject.toml')):
if 'lib/cli' in p.parts or 'lib/crewai-core' in p.parts:
text=p.read_text()
m=re.search(r'^\[project\]\n', text, re.M); start=m.start()+len(m.group()) if m else text.find('\nproject') if 'project' in text else 0
print(f"\n--- {p} ---")
print(text[:500])
# Print lines mentioning name/package-dir/dependencies for context
for i,line in enumerate(text.splitlines(),1):
if i<220 and ('name =' in line or 'package' in line or 'dependencies' in line or 'packages' in line):
print(f"{i}: {line}")
PY
echo
echo "== git status/diff stat summary =="
git status --short
git diff --staged --stat || true
git diff --stat || trueRepository: crewAIInc/crewAI
Length of output: 684
Reconcile the package table with the uv workspace.
pyproject.toml lists four workspace members and uv.lock locks the same four packages; the six-package table documents lib/cli and lib/crewai-core, but there are no corresponding package manifests in those locations. Add those packages to the workspace configuration and regenerate uv.lock, or reduce this table to the four managed packages.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “CLI”.
Context: ...elease tooling | | cli | lib/cli/ | CLI interface | | crewai-core | lib/crewai-core/ ...
(ACRONYM_TAUTOLOGY)
🤖 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 @.github/CONTRIBUTING.md around lines 32 - 41, Reconcile the six-package
table in the “uv workspace” section with the actual workspace configuration:
either add valid package manifests for lib/cli and lib/crewai-core, include them
in pyproject.toml workspace members, and regenerate uv.lock, or remove those two
entries so the table lists only the four managed packages.
| | `crewai-tools` | `lib/crewai-tools/` | Tool integrations | | ||
| | `crewai-files` | `lib/crewai-files/` | File handling | | ||
| | `devtools` | `lib/devtools/` | Internal release tooling | | ||
| | `cli` | `lib/cli/` | CLI interface | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use “CLI” instead of “CLI interface.”
“CLI interface” redundantly expands the acronym in the description.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “CLI”.
Context: ...elease tooling | | cli | lib/cli/ | CLI interface | | crewai-core | lib/crewai-core/ ...
(ACRONYM_TAUTOLOGY)
🤖 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 @.github/CONTRIBUTING.md at line 40, Update the cli entry in the contribution
guide’s component table to describe it as “CLI” rather than “CLI interface,”
leaving the path and other entries unchanged.
Source: Linters/SAST tools
1 participant
Description\n\nFixes #6664 - Incorrect number of workspaces in CONTRIBUTING.md\n\nThe defines 6 workspace members but the CONTRIBUTING.md only listed 4 packages and stated "four packages".\n\n## Changes\n\n1. Updated the count from "four packages" to "six packages"\n2. Added the missing packages to the table:\n - - CLI interface\n - - Core agents architecture\n\n## Verification\n\nCompare with lines 237-245:\n\n\nThis PR aligns the documentation with the actual workspace configuration.