mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-08-10 16:32:28 +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.
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# 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
|
|
|
|
1. Follow Python best practices and idiomatic patterns.
|
|
2. Maintain existing code structure and organization.
|
|
3. Write unit tests for new functionality focusing on behaivor and not
|
|
implementation.
|
|
4. Document public APIs and complex logic.
|
|
5. Suggest changes to the `docs/` folder when appropriate
|
|
6. Follow software principles such as DRY and YAGNI.
|
|
7. Keep diffs as minimal as possible.
|
|
|
|
## Changing Docs
|
|
|
|
1. Edit MDX under `docs/edge/en/*` and reference it from `docs/docs.json` if
|
|
needed.
|
|
2. Do not modify files under `docs/v*/`. Those are frozen release snapshots
|
|
managed by devtools.
|
|
3. Do not delete or rename files under `docs/images/` as frozen snapshots
|
|
may reference them.
|
|
4. If you want to preview your changes locally, use `cd docs && mintlify dev`.
|
|
To check for broken links, run `cd docs && mintlify broken-links`.
|
|
5. After editing English docs, sync translations to `ar`, `ko`, and `pt-BR`
|
|
before finishing the task. Follow [DOCS_TRANSLATIONS.md](DOCS_TRANSLATIONS.md).
|