اکوان
مستندات اکوان
مستندات/مشارکت

مشارکت در توسعه

محیط توسعه را آماده کنید و تغییرات خود را برای پروژه ارسال کنید.

ایجنت اکوان با Python ساخته شده و تحت مجوز MIT منتشر می‌شود. بررسی تغییرات کوچک و متمرکز، به‌ویژه همراه با تست و مستندات، آسان‌تر و سریع‌تر است.

آماده‌سازی محیط توسعه

bash
git clone https://github.com/akvanai/akvan-agent.git
cd akvan-agent
uv sync --all-extras

اجرای تست‌ها:

bash
uv run pytest

اجرای نسخهٔ محلی CLI:

bash
uv run akvan

محدوده‌های اصلی پروژه

  • agent/providers/ برای اتصال به providerهای مدل
  • agent/tools/ برای ابزارها و سیاست اجرای آن‌ها
  • agent/gateway/ برای کانال‌هایی مانند Telegram
  • agent/skills/ برای موتور کشف و همگام‌سازی skills
  • skills/<category>/<name>/SKILL.md برای محتوای skills آماده
  • tests/ برای تست‌های خودکار

یکپارچه‌سازی provider اکوان (سرویس سمت سرور) در مخزن akvan-ai در مسیر akvan-backend/agent/ قرار دارد. پیاده‌سازی CLI در akvan-agent/agent/providers/akvan.py است.

پیش از تغییر مرزهای بسته‌ها، فایل ARCHITECTURE.md مخزن را بخوانید.

افزودن قابلیت

هر provider باید از قرارداد پایه، تبدیل پیام، streaming، tool call و مدیریت خطای استاندارد پشتیبانی کند. هر ابزار تازه باید schema ورودی روشن و سیاست ایمنی متناسب داشته باشد. هر gateway جدید نیز باید تنظیمات، احراز هویت، قابلیت‌ها و dependencyهای اختیاری خود را به‌صورت مستقل نگه دارد.

pull request خوب

  1. یک مسئله را حل می‌کند و تغییرهای نامرتبط ندارد.
  2. رفتار تازه را با تست پوشش می‌دهد.
  3. مستندات کاربر را در همان تغییر به‌روز می‌کند.
  4. اثر امنیتی و سازگاری با نسخه‌های قبلی را توضیح می‌دهد.
  5. uv run pytest را با موفقیت اجرا می‌کند.

پیش از ارسال، راهنمای CONTRIBUTING.md، سیاست امنیتی و Code of Conduct مخزن را مرور کنید.