AGENTS.md nedir?
AGENTS.md, kodlama agent'lerine yönelik depoya özel talimatlar için kullanılan bir Markdown dosyasıdır. Ekipler komutları, kod kurallarını, test beklentilerini, dizin sınırlarını ve güvenlik notlarını koda yakın biçimde kaydeder. İnsanlara yönelik dokümanları tamamlar. Dosyaların nasıl bulunduğu ve çakışmaların nasıl çözüldüğü kullanılan agente bağlıdır.
AGENTS.md neler içermeli?
Depoyu güvenli biçimde değiştirmek için gereken komutları ve sınırları ekleyin: kurulum, hedefli kontroller, biçimlendirme, mimari sınırlar, hassas yollar ve tamamlanma ölçütü. Genel tercihler yerine çalıştırılabilir ayrıntıları seçin.
Nasıl güncel tutulmalı?
Dosyayı kod inceleme kapsamının bir parçası sayın. Betikler değiştiğinde komutları güncelleyin, eski kuralları kaldırın ve alt dizin talimatlarını yönettiği alanla sınırlı tutun.
Kullanışlı talimat kategorileri
| Kategori | Ekleyin | Kaçının |
|---|---|---|
| Komutlar | Kesin kurulum, test, lint ve build komutları | Artık var olmayan komutlar |
| Sınırlar | Sahip olunan yollar ve özel dikkat isteyen dosyalar | Nedensiz belirsiz uyarılar |
| Tamamlama | Gerekli kontroller ve beklenen kanıt | Doğrulanamayan kalite sloganları |
AGENTS.md bakım listesi
- Her komut belirtilen dizinden çalışır.
- Kurallar kapsamını ve nedenini belirtir.
- Hassas dosyalar ve yasak işlemler adlandırılır.
- Proje betikleri veya yapısı değiştiğinde dosya gözden geçirilir.
Sık sorulan sorular
AGENTS.md zorunlu mu?
Hayır. İsteğe bağlı bir yaklaşımdır. Değeri, agentin dosyayı tanımasına ve talimatların doğruluğuna bağlıdır.
AGENTS.md README.md'nin yerini alır mı?
Hayır. README.md insanlara yöneliktir; AGENTS.md kodlama agent'lerine özel operasyonel yönlendirmeleri taşıyabilir.
Bir depoda birden fazla AGENTS.md olabilir mi?
Açık format iç içe dosyaları tanımlar; ancak keşif ve öncelik davranışı kullandığınız her agent için doğrulanmalıdır.
AGENTS.md içine gizli bilgiler yazılmalı mı?
Hayır. Gizli değerleri kaydetmeden kimlik bilgilerinin nasıl edinilip yönetileceğini belgeleyin.
AGENTS.md dosyasını kim güncel tutmalı?
İlgili kodun sahibi ekip, dosyayı build betikleri, mimari ve katkı kurallarıyla birlikte incelemelidir.