ਇੱਕ AGENTS.md ਫਾਈਲ ਕਦਮ-ਦਰ-ਕਦਮ ਬਣਾਓ
ਇੱਕ AGENTS.md ਫਾਈਲ ਤੁਹਾਡੇ ਰੈਪੋ (repo) ਦੇ ਰੂਟ ਵਿੱਚ ਇੱਕ ਸਿੰਗਲ ਮਾਰਕਡਾਊਨ ਫਾਈਲ ਹੁੰਦੀ ਹੈ। ਇਹ AI ਕੋਡਿੰਗ ਏਜੰਟਾਂ ਨੂੰ ਦੱਸਦੀ ਹੈ ਕਿ ਕਿਵੇਂ ਕੰਮ ਕਰਨਾ ਹੈ। ਇਸ ਵਿੱਚ ਬਿਲਡ ਸਟੈਪਸ, ਟੈਸਟ ਅਤੇ ਨਿਯਮ ਸ਼ਾਮਲ ਹੁੰਦੇ ਹਨ।
ਇੱਕ Python FastAPI ਪ੍ਰੋਜੈਕਟ ਲਈ ਇਸਨੂੰ ਬਣਾਉਣ ਲਈ ਇਹਨਾਂ ਕਦਮਾਂ ਦੀ ਪਾਲਣਾ ਕਰੋ।
ਸਟੈਕ (stack) ਨੂੰ ਪਰਿਭਾਸ਼ਿਤ ਕਰੋ ਇੱਕ ਵਾਕ ਨਾਲ ਸ਼ੁਰੂਆਤ ਕਰੋ। ਏਜੰਟ ਨੂੰ ਭਾਸ਼ਾ, ਫਰੇਮਵਰਕ ਅਤੇ ਡਾਟਾਬੇਸ ਬਾਰੇ ਦੱਸੋ। ਉਦਾਹਰਨ: FastAPI, SQLite, ਅਤੇ pytest ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹੋਏ Python ਵਿੱਚ ਇੱਕ URL shortener API।
ਸੈੱਟਅੱਪ ਕਮਾਂਡਾਂ ਪ੍ਰਦਾਨ ਕਰੋ ਏਜੰਟ ਨੂੰ ਚਲਾਉਣ ਲਈ ਅਸਲ ਕਮਾਂਡਾਂ ਦਿਓ। ਪਲੇਸਹੋਲਡਰਾਂ ਦੀ ਵਰਤੋਂ ਨਾ ਕਰੋ।
- Setup: python -m venv .venv && source .venv/bin/activate
- Run: uvicorn app.main:app --reload
- ਟੈਸਟਿੰਗ ਦਾ ਮਿਆਰ ਸੈੱਟ ਕਰੋ ਇਹ ਬਹੁਤ ਮਹੱਤਵਪੂਰਨ ਹੈ। ਏਜੰਟ ਆਪਣੇ ਕੰਮ ਦੀ ਜਾਂਚ ਕਰਨ ਲਈ ਟੈਸਟਾਂ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ।
- Run pytest
- Run ruff check
- Run mypy
- ਢਾਂਚੇ (structure) ਦਾ ਨਕਸ਼ਾ ਤਿਆਰ ਕਰੋ ਆਪਣੇ ਫੋਲਡਰਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ ਤਾਂ ਜੋ ਏਜੰਟ ਨੂੰ ਹਰ ਫਾਈਲ ਖੋਜਣ ਦੀ ਲੋੜ ਨਾ ਪਵੇ।
- app/main.py: route handlers
- app/db.py: SQLite access
- migrations/: ਜਨਰੇਟਡ SQL (ਐਡਿਟ ਨਾ ਕਰੋ)
- ਕਨਵੈਨਸ਼ਨਾਂ (conventions) ਪਰਿਭਾਸ਼ਿਤ ਕਰੋ ਸਪੱਸ਼ਟ ਰਹੋ। ਅਸਪਸ਼ਟ ਨਿਯਮ ਬੇਕਾਰ ਹੁੰਦੇ ਹਨ।
- ਸਾਰੇ input validation ਲਈ Pydantic ਦੀ ਵਰਤੋਂ ਕਰੋ।
- client errors ਲਈ HTTPException ਰੇਜ਼ (raise) ਕਰੋ।
- mypy ਨੂੰ ਸਾਫ਼ ਰੱਖਣ ਲਈ ਹਰ ਚੀਜ਼ ਨੂੰ ਟਾਈਪ (type) ਕਰੋ।
- "ਕੀ ਨਹੀਂ ਕਰਨਾ" (Don'ts) ਦੀ ਸੂਚੀ ਬਣਾਓ ਸਖ਼ਤ ਸੀਮਾਵਾਂ ਮਿੱਥ ਕੇ ਗਲਤੀਆਂ ਨੂੰ ਰੋਕੋ।
- migrations ਨੂੰ ਹੱਥ ਨਾਲ ਐਡਿਟ ਨਾ ਕਰੋ।
- ਸਿੱਧਾ main ਵਿੱਚ ਕਮਿਟ (commit) ਨਾ ਕਰੋ।
- ਕਦੇ ਵੀ non-local ਡਾਟਾਬੇਸਾਂ 'ਤੇ seed ਸਕ੍ਰਿਪਟਾਂ ਨਾ ਚਲਾਓ।
ਇਹ ਕਿਉਂ ਕੰਮ ਕਰਦਾ ਹੈ ਜਦੋਂ ਤੁਸੀਂ ਕਿਸੇ AI ਏਜੰਟ ਨੂੰ "Add a DELETE endpoint" ਵਰਗਾ ਕੰਮ ਦਿੰਦੇ ਹੋ, ਤਾਂ ਉਹ ਪਹਿਲਾਂ ਇਸ ਫਾਈਲ ਨੂੰ ਪੜ੍ਹਦਾ ਹੈ।
ਇੱਕ AGENTS.md ਫਾਈਲ ਦੇ ਨਾਲ, ਏਜੰਟ:
- ਜਾਣਦਾ ਹੈ ਕਿ ਕੋਡ ਬਿਲਕੁਲ ਕਿੱਥੇ ਜੋੜਨਾ ਹੈ।
- ਤੁਹਾਡੇ ਖਾਸ ਟੈਸਟਿੰਗ ਟੂਲਸ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ।
- ਬਿਨਾਂ ਸਵਾਲ ਪੁੱਛੇ ਤੁਹਾਡੀ ਸ਼ੈਲੀ ਦੀ ਪਾਲਣਾ ਕਰਦਾ ਹੈ।
- ਤੁਹਾਡੇ ਮੇਨ ਕੋਡ ਨੂੰ ਖਰਾਬ ਕਰਨ ਦੀ ਬਜਾਏ ਇੱਕ ਬ੍ਰਾਂਚ (branch) ਖੋਲ੍ਹਦਾ ਹੈ।
ਇਸ ਫਾਈਲ ਤੋਂ ਬਿਨਾਂ, ਏਜੰਟ ਅੰਦਾਜ਼ਾ ਲਗਾਉਂਦਾ ਹੈ। ਇਹ ਗਲਤ ਟੈਸਟ ਰਨਰ ਦੀ ਵਰਤੋਂ ਕਰ ਸਕਦਾ ਹੈ ਜਾਂ ਉਹਨਾਂ ਫਾਈਲਾਂ ਨੂੰ ਐਡਿਟ ਕਰ ਸਕਦਾ ਹੈ ਜਿਨ੍ਹਾਂ ਨੂੰ ਨਹੀਂ ਛੂਹਣਾ ਚਾਹੀਦਾ।
ਇਸ ਫਾਈਲ ਨੂੰ ਕੋਡ ਵਾਂਗ ਸਮਝੋ। ਜੇਕਰ ਤੁਹਾਡਾ ਵਰਕਫਲੋ (workflow) ਬਦਲਦਾ ਹੈ, ਤਾਂ ਤੁਰੰਤ ਫਾਈਲ ਨੂੰ ਅਪਡੇਟ ਕਰੋ। ਇੱਕ ਪੁਰਾਣੀ (stale) ਫਾਈਲ ਗਲਤੀਆਂ ਦਾ ਕਾਰਨ ਬਣਦੀ ਹੈ।
Source: https://dev.to/wolfejam/agentsmd-hands-on-build-one-step-by-step-and-watch-an-agent-use-it-3g27
Optional learning community: https://t.me/GyaanSetuAi