Bina Fail AGENTS.MD Langkah Demi Langkah

Fail AGENTS.md ialah satu fail Markdown tunggal di akar (root) repo anda. Ia memberitahu ejen pengekodan AI cara untuk bekerja. Ia merangkumi langkah binaan, ujian, dan peraturan.

Ikuti langkah-langkah ini untuk membina satu bagi projek Python FastAPI.

  1. Takrifkan stack Mulakan dengan satu ayat. Beritahu ejen bahasa, rangka kerja (framework), dan pangkalan data. Contoh: Sebuah API pemendek URL dalam Python menggunakan FastAPI, SQLite, dan pytest.

  2. Sediakan arahan penyediaan (setup) Berikan ejen arahan sebenar untuk dijalankan. Jangan gunakan placeholder.

  • Setup: python -m venv .venv && source .venv/bin/activate
  • Run: uvicorn app.main:app --reload
  1. Tetapkan piawaian ujian Ini sangat penting. Ejen menggunakan ujian untuk menyemak kerjanya sendiri.
  • Run pytest
  • Run ruff check
  • Run mypy
  1. Petakan struktur Senaraikan folder anda supaya ejen tidak perlu mencari setiap fail.
  • app/main.py: pengendali laluan (route handlers)
  • app/db.py: akses SQLite
  • migrations/: SQL yang dijana (jangan edit)
  1. Takrifkan konvensyen Jadilah spesifik. Peraturan yang samar-samar tidak berguna.
  • Gunakan Pydantic untuk semua pengesahan input.
  • Gunakan HTTPException untuk ralat klien.
  • Berikan jenis (type) pada semua perkara untuk memastikan mypy kekal bersih.
  1. Senaraikan "Perkara yang Tidak Boleh Dilakukan" Cegah kesilapan dengan menetapkan sempadan yang tegas.
  • Jangan edit migrasi secara manual.
  • Jangan commit terus ke main.
  • Jangan sekali-kali jalankan skrip seed pada pangkalan data bukan tempatan (non-local).

Mengapa ini berkesan Apabila anda memberikan tugasan kepada ejen AI seperti "Tambah endpoint DELETE," ia akan membaca fail ini terlebih dahulu.

Dengan fail AGENTS.md, ejen:

  • Tahu dengan tepat di mana untuk menambah kod.
  • Menggunakan alatan ujian khusus anda.
  • Mengikut gaya anda tanpa bertanya soalan.
  • Membuka cawangan (branch) dan bukannya merosakkan kod utama anda.

Tanpa fail ini, ejen akan membuat tekaan. Ia mungkin menggunakan pelari ujian (test runner) yang salah atau mengedit fail yang tidak sepatutnya disentuh.

Anggap fail ini seperti kod. Jika aliran kerja anda berubah, kemas kini fail tersebut dengan segera. Fail yang lapuk akan menyebabkan ralat.

Sumber: https://dev.to/wolfejam/agentsmd-hands-on-build-one-step-by-step-and-watch-an-agent-use-it-3g27

Komuniti pembelajaran pilihan: https://t.me/GyaanSetuAi