- AGENTS.md README की पूरक भूमिका निभाता है और यह एक dedicated file है जिसमें AI coding agents के लिए प्रोजेक्ट पर काम करते समय ज़रूरी context और instructions रखे जाते हैं
- 20,000 से अधिक open source projects में इसका उपयोग हो रहा है, जहाँ build/test/code style जैसी ऐसी जानकारी व्यवस्थित की जाती है जो इंसानों के लिए अनावश्यक हो सकती है, लेकिन agents के लिए महत्वपूर्ण होती है
- स्पष्ट और अनुमानित location पर agent-specific instructions देकर README को संक्षिप्त रखा जा सकता है और साथ ही collaboration efficiency भी बढ़ती है
- एक ही AGENTS.md कई agents और tools के साथ compatible है, और बड़े monorepo में subproject-वार अलग AGENTS.md का उपयोग किया जा सकता है
- OpenAI Codex, Cursor, Google Jules आदि कई ecosystems के सहयोग से बना एक open standard
Why AGENTS.md?
- README.md इंसानों के लिए documentation है, जो quick start, project description और contribution guidelines देता है
- AGENTS.md agents के लिए एक सहायक document है, जो build/test/code rules जैसे detailed context को रखता है ताकि README जटिल न बने
- इसे अलग file में रखने के कारण
- agents के संदर्भ के लिए instructions का एक predictable location देना
- README को human contributors-केंद्रित और संक्षिप्त बनाए रखना
- मौजूदा documentation को पूरक करने वाली precise agent-specific instructions देना
- proprietary format की जगह ऐसा open standard नाम अपनाया गया है जिसे कोई भी उपयोग कर सके
- एक AGENTS.md के साथ कई AI coding agents और tools के साथ compatibility संभव है
How to use AGENTS.md?
- 1. AGENTS.md file बनाएं
- इसे repository root में रखें (कई agents auto-generation को support करते हैं)
- 2. मुख्य sections लिखें
- project overview
- build और test commands
- code style guidelines
- testing method
- security considerations
- 3. अतिरिक्त instructions शामिल करें
- commit/PR rules, security precautions, large datasets, deployment steps आदि, यानी वे बातें जो टीम सदस्यों तक पहुँचानी हों
- 4. monorepo support
- हर package के लिए अलग AGENTS.md रखा जा सकता है
- agents सबसे नज़दीकी file पढ़ते हैं और उसी subproject के अनुसार instructions का पालन करते हैं
- उदाहरण: OpenAI repository में 88 AGENTS.md मौजूद हैं
FAQ
- ज़रूरी sections: कोई नहीं, सामान्य Markdown format में स्वतंत्र रूप से लिखा जा सकता है
- conflict होने पर: सबसे नज़दीकी AGENTS.md को प्राथमिकता मिलती है, और user का explicit prompt अंतिम रूप से लागू होता है
- auto-execution: file में दिए गए test commands को agent चला सकता है और errors ठीक करने की कोशिश कर सकता है
- update की संभावना: इसे कभी भी बदला जा सकता है, इसलिए इसे living document की तरह manage किया जाता है
- मौजूदा documents का migration: filename बदलने के बाद symbolic link से compatibility बनाए रखी जा सकती है
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
अभी कोई टिप्पणी नहीं है.