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

کار با پروژه‌ها

project root، دستورالعمل‌های محلی و جریان کم‌ریسک تغییر کد را مدیریت کنید.

Akvan را از مسیر اصلی repository اجرا کنید؛ همان جایی که معمولاً .git، فایل‌های config و پوشه‌های اصلی پروژه قرار دارند. Akvan از روی نزدیک‌ترین .git، مقدار project_root را تشخیص می‌دهد و ابزارهای فایل و terminal معمولاً pathهای نسبی را نسبت به همین مسیر تفسیر می‌کنند.

project_root، cwd و workdir

  • project_root: نزدیک‌ترین پوشهٔ دارای .git؛ اگر .git پیدا نشود، همان مسیر اجرای Akvan است.
  • cwd: مسیری که فرمان akvan را از آن اجرا کرده‌اید و در prompt metadata ثبت می‌شود.
  • workdir: مسیر اجرای یک command در ابزار terminal. اگر مشخص نشود، مقدار پیش‌فرض آن project_root است.
bash
cd ~/code/my-project
akvan

پیش از درخواست تغییرات بزرگ، از Akvan بخواهید وضعیت repository، فایل‌های مرتبط و تست‌های موجود را بررسی کند.

دستورالعمل‌های پروژه

Akvan دستورالعمل‌های محلی را از cwd به سمت project_root جست‌وجو می‌کند. ابتدا در هر سطح دنبال .akvan.md و AKVAN.md می‌گردد؛ اگر چیزی پیدا نشد، همین مسیر را برای AGENTS.md بررسی می‌کند.

در این فایل دربارهٔ command تست، قراردادهای نام‌گذاری، محدودیت‌های معماری و فایل‌هایی که نباید تغییر کنند بنویسید.

md
# Project instructions

- Run `pytest tests/unit` after Python changes.
- Do not edit generated files under `dist/`.
- Keep public API changes backward compatible.

یک جریان کاری مطمئن

  1. هدف و معیار پایان را دقیق بیان کنید.
  2. ابتدا بررسی و plan کوتاه بخواهید.
  3. تغییر را در محدوده‌ای کوچک نگه دارید.
  4. تست مرتبط را اجرا کنید.
  5. پیش از commit، تغییرات را یک‌بار دیگر مرور کنید.

عملیات معمول داخل پروژه بدون approval انجام می‌شوند؛ write بیرون پروژه، تغییر فایل حساس و commandهای خطرناک به approval نیاز دارند. این approvalها جای sandbox واقعی را نمی‌گیرند، پس خروجی و مسیر commandها را با دقت بخوانید.