- AGENTS.md, README'yi tamamlayıcı bir rol üstlenir ve AI kodlama ajanlarının projede çalışırken ihtiyaç duyduğu bağlamı ve yönergeleri içeren özel bir dosyadır
- 20.000'den fazla açık kaynak proje tarafından kullanılıyor; derleme/test/kod stili gibi insanlar için gereksiz ama ajanlar için önemli bilgileri düzenler
- Ajanlara özel yönergeleri net ve öngörülebilir bir konumda sunarak README'yi sade tutarken işbirliği verimliliğini artırır
- Tek bir AGENTS.md ile çeşitli ajanlar ve araçlarla uyumludur; büyük monorepo'larda alt projelere özel ayrı AGENTS.md dosyaları kullanılabilir
- OpenAI Codex, Cursor, Google Jules gibi birçok ekosistemin işbirliğiyle oluşturulmuş açık bir standarttır
Why AGENTS.md?
- README.md insanlar için hazırlanmış bir dokümandır; hızlı başlangıç, proje açıklaması ve katkı yönergeleri sunar
- AGENTS.md, ajanlar için yardımcı bir dokümandır; derleme/test/kod kuralları gibi ayrıntılı bağlamı içererek README'yi karmaşık hale getirmez
- Ayrı bir dosya olmasının nedenleri
- Ajanların başvuracağı öngörülebilir bir yönerge konumu sağlar
- README, insan katkıcıları merkeze alarak sade kalır
- Mevcut dokümanları tamamlayan daha hassas, ajana özel yönergeler sunar
- Sahipli bir format yerine herkesin kullanabileceği açık standart adlandırması benimsenmiştir
- Tek bir AGENTS.md ile birden fazla AI kodlama ajanı ve araçla uyumluluk sağlanabilir
How to use AGENTS.md?
- 1. AGENTS.md dosyasını oluşturun
- Depo köküne yerleştirin (birçok ajan otomatik oluşturmayı destekler)
- 2. Temel bölümleri yazın
- Proje özeti
- Derleme ve test komutları
- Kod stili yönergeleri
- Test yöntemi
- Güvenlik değerlendirmeleri
- 3. Ek yönergeler ekleyin
- Commit/PR kuralları, güvenlik uyarıları, büyük veri kümeleri, dağıtım adımları gibi ekip üyelerine iletilmek istenen içerikler
- 4. Monorepo desteği
- Her paket için ayrı AGENTS.md yerleştirilebilir
- Ajanlar en yakın dosyayı okuyarak ilgili alt projeye uygun yönergeleri izler
- Örnek: OpenAI deposunda 88 adet AGENTS.md bulunuyor
FAQ
- Zorunlu alanlar: Yok; genel Markdown biçimi serbestçe kullanılabilir
- Çakışma durumunda: En yakın AGENTS.md önceliklidir, kullanıcı tarafından açıkça verilen prompt son olarak uygulanır
- Otomatik çalıştırma: Dosyada belirtilen test komutları ajan tarafından çalıştırılarak hataları düzeltme girişiminde bulunulabilir
- Güncellenebilirlik: İstenildiği zaman değiştirilebilir, canlı bir doküman olarak yönetilir
- Mevcut dokümanların taşınması: Dosya adı değiştirildikten sonra sembolik bağlantıyla uyumluluk korunabilir
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
Henüz yorum yok.