mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-08-10 08:21:54 +00:00
03e3724bff
* docs: add DOCS_TRANSLATIONS workflow for locale sync Document how to git-detect English MDX changes and sync ar, ko, and pt-BR translations, and reference it from AGENTS.md. * docs: add fence language tags in DOCS_TRANSLATIONS.md Mark the checklist and example output blocks with markdown and text identifiers for correct rendering.
1.2 KiB
1.2 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. - After editing English docs, sync translations to
ar,ko, andpt-BRbefore finishing the task. Follow DOCS_TRANSLATIONS.md.