ba5ae13cc1
Build uv cache / build-cache (3.10) (push) Has been cancelled
Build uv cache / build-cache (3.11) (push) Has been cancelled
Build uv cache / build-cache (3.12) (push) Has been cancelled
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Check Documentation Broken Links / Check broken links (push) Has been cancelled
Vulnerability Scan / pip-audit (push) Has been cancelled
Build uv cache / build-cache (3.13) (push) Has been cancelled
1.0 KiB
1.0 KiB
Agent Instructions for CrewAI OSS
CrewAI is a Python based framework for building AI agents and agentic systems. Follow these guidelines when contributing:
Key Guidelines
- Follow Python best practices and idiomatic patterns.
- Maintain existing code structure and organization.
- Write unit tests for new functionality focusing on behaivor and not implementation.
- Document public APIs and complex logic.
- Suggest changes to the
docs/folder when appropriate - Follow software principles such as DRY and YAGNI.
- Keep diffs as minimal as possible.
Changing Docs
- Edit MDX under
docs/edge/en/*and reference it fromdocs/docs.jsonif needed. - Do not modify files under
docs/v*/. Those are frozen release snapshots managed by devtools. - Do not delete or rename files under
docs/images/as frozen snapshots may reference them. - If you want to preview your changes locally, use
cd docs && mintlify dev. To check for broken links, runcd docs && mintlify broken-links.