CLAUDE.md ਨੂੰ ਸਹੀ ਤਰੀਕੇ ਨਾਲ ਕਿਵੇਂ ਖੋਲ੍ਹਣਾ ਹੈ
CLAUDE.md ਨੂੰ ਸਹੀ ਤਰੀਕੇ ਨਾਲ ਕਿਵੇਂ ਖੋਲ੍ਹਣਾ ਹੈ
CLAUDE.md ਇੱਕ ਵਿਸ਼ੇਸ਼ ਫਾਈਲ ਹੈ ਜੋ ਪ੍ਰੋਜੈਕਟ ਦੇ ਰੂਟ ਡਾਇਰੈਕਟਰੀ ਵਿੱਚ ਰੱਖੀ ਜਾਂਦੀ ਹੈ, ਜੋ AI ਸਹਾਇਕਾਂ (ਜਿਵੇਂ ਕਿ Claude) ਨੂੰ ਤੁਹਾਡੇ ਪ੍ਰੋਜੈਕਟ ਬਾਰੇ ਮੁੱਖ ਜਾਣਕਾਰੀ ਦੱਸਦੀ ਹੈ। ਇਸ ਫਾਈਲ ਨੂੰ ਚੰਗੀ ਤਰ੍ਹਾਂ ਲਿਖਣ ਨਾਲ, AI ਨੂੰ ਬਿਹਤਰ ਤਰੀਕੇ ਨਾਲ ਸਮਝਣ ਅਤੇ ਤੁਹਾਡੀ ਮਦਦ ਕਰਨ ਵਿੱਚ ਮਦਦ ਮਿਲੇਗੀ।
CLAUDE.md ਦੀ ਲੋੜ ਕਿਉਂ ਹੈ?
ਕਲਪਨਾ ਕਰੋ, ਤੁਹਾਡਾ ਇੱਕ ਨਵਾਂ ਸਹਿਯੋਗੀ ਆਇਆ ਹੈ, ਤੁਹਾਨੂੰ ਉਸਨੂੰ ਆਪਣੇ ਪ੍ਰੋਜੈਕਟ ਨੂੰ ਸਮਝਾਉਣ ਵਿੱਚ ਕਿੰਨਾ ਸਮਾਂ ਲੱਗੇਗਾ? CLAUDE.md ਉਹ "ਪ੍ਰੋਜੈਕਟ ਮੈਨੂਅਲ" ਹੈ, ਜੋ AI ਨੂੰ ਜਲਦੀ ਸ਼ੁਰੂ ਕਰਨ ਵਿੱਚ ਮਦਦ ਕਰਦਾ ਹੈ।
CLAUDE.md ਦੇ ਪੰਜ ਮੁੱਖ ਤੱਤ
1. ਪ੍ਰੋਜੈਕਟ ਸੰਖੇਪ ਜਾਣਕਾਰੀ
ਸੰਖੇਪ ਵਿੱਚ ਦੱਸੋ ਕਿ ਇਹ ਪ੍ਰੋਜੈਕਟ ਕੀ ਕਰਦਾ ਹੈ, ਇਹ ਕਿਹੜੀਆਂ ਸਮੱਸਿਆਵਾਂ ਨੂੰ ਹੱਲ ਕਰਦਾ ਹੈ, ਅਤੇ ਇਹ ਕਿਹੜੇ ਉਪਭੋਗਤਾਵਾਂ ਲਈ ਹੈ।
# ਪ੍ਰੋਜੈਕਟ ਸੰਖੇਪ ਜਾਣਕਾਰੀ ਇਹ ਇੱਕ ਈ-ਕਾਮਰਸ ਬੈਕਐਂਡ ਪ੍ਰਬੰਧਨ ਸਿਸਟਮ ਹੈ, ਜੋ ਉਤਪਾਦਾਂ, ਆਦੇਸ਼ਾਂ ਅਤੇ ਉਪਭੋਗਤਾਵਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰਨ ਲਈ ਵਰਤਿਆ ਜਾਂਦਾ ਹੈ।
2. ਤਕਨੀਕੀ ਸਟੈਕ
ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਵਰਤੀਆਂ ਗਈਆਂ ਮੁੱਖ ਤਕਨੀਕਾਂ ਅਤੇ ਫਰੇਮਵਰਕ ਦੀ ਸੂਚੀ ਬਣਾਓ।
`# ਤਕਨੀਕੀ ਸਟੈਕ
- ਫਰੰਟਐਂਡ: React + TypeScript
- ਬੈਕਐਂਡ: Node.js + Express
- ਡਾਟਾਬੇਸ: PostgreSQL
- ਤਾਇਨਾਤੀ: Docker + Kubernetes`
3. ਫਾਈਲ ਢਾਂਚਾ
ਮੁੱਖ ਡਾਇਰੈਕਟਰੀਆਂ ਦੇ ਕਾਰਜਾਂ ਦੀ ਵਿਆਖਿਆ ਕਰੋ।
# ਫਾਈਲ ਢਾਂਚਾ /src /components - UI ਕੰਪੋਨੈਂਟ /pages - ਪੰਨੇ /utils - ਸਹੂਲਤ ਫੰਕਸ਼ਨ /api - API ਕਾਲਾਂ
4. ਆਮ ਤੌਰ 'ਤੇ ਵਰਤੇ ਜਾਣ ਵਾਲੇ ਕਮਾਂਡਾਂ
ਵਿਕਾਸ ਵਿੱਚ ਆਮ ਤੌਰ 'ਤੇ ਵਰਤੇ ਜਾਣ ਵਾਲੇ ਕਮਾਂਡਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ।
# ਆਮ ਤੌਰ 'ਤੇ ਵਰਤੇ ਜਾਣ ਵਾਲੇ ਕਮਾਂਡਾਂ npm run dev - ਵਿਕਾਸ ਸਰਵਰ ਸ਼ੁਰੂ ਕਰੋ npm run build - ਉਤਪਾਦਨ ਸੰਸਕਰਣ ਬਣਾਓ npm run test - ਟੈਸਟ ਚਲਾਓ
5. ਨਿਯਮ
AI ਦੁਆਰਾ ਤੁਹਾਡੇ ਲਈ ਕੋਡ ਲਿਖਣ ਵੇਲੇ ਪਾਲਣ ਕੀਤੇ ਜਾਣ ਵਾਲੇ ਨਿਯਮਾਂ ਨੂੰ ਪਰਿਭਾਸ਼ਿਤ ਕਰੋ।
`# ਕੋਡਿੰਗ ਨਿਯਮ
- ਫੰਕਸ਼ਨਲ ਕੰਪੋਨੈਂਟਸ ਦੀ ਵਰਤੋਂ ਕਰੋ
- ESLint ਸੰਰਚਨਾ ਦੀ ਪਾਲਣਾ ਕਰੋ
- ਕੰਪੋਨੈਂਟ ਨਾਮਕਰਨ ਲਈ PascalCase ਦੀ ਵਰਤੋਂ ਕਰੋ
- ਵੇਰੀਏਬਲ ਨਾਮਕਰਨ ਲਈ camelCase ਦੀ ਵਰਤੋਂ ਕਰੋ`
ਇੱਕ ਪੂਰੀ ਉਦਾਹਰਣ
`# ਪ੍ਰੋਜੈਕਟ ਦਾ ਨਾਮ: Task Manager
ਪ੍ਰੋਜੈਕਟ ਸੰਖੇਪ ਜਾਣਕਾਰੀ
ਇੱਕ ਸਧਾਰਨ ਟਾਸਕ ਮੈਨੇਜਮੈਂਟ ਐਪਲੀਕੇਸ਼ਨ, ਜੋ ਟਾਸਕ ਬਣਾਉਣ, ਸੰਪਾਦਿਤ ਕਰਨ, ਮਿਟਾਉਣ ਅਤੇ ਵਰਗੀਕਰਨ ਦਾ ਸਮਰਥਨ ਕਰਦੀ ਹੈ।
ਤਕਨੀਕੀ ਸਟੈਕ
- React 18
- TypeScript
- Tailwind CSS
- Vite
ਫਾਈਲ ਢਾਂਚਾ
/src /components - UI ਕੰਪੋਨੈਂਟ /hooks - ਕਸਟਮ Hooks /types - TypeScript ਕਿਸਮ ਪਰਿਭਾਸ਼ਾਵਾਂ /utils - ਸਹੂਲਤ ਫੰਕਸ਼ਨ
ਆਮ ਤੌਰ 'ਤੇ ਵਰਤੇ ਜਾਣ ਵਾਲੇ ਕਮਾਂਡਾਂ
- npm run dev: ਵਿਕਾਸ ਸਰਵਰ ਸ਼ੁਰੂ ਕਰੋ
- npm run build: ਉਤਪਾਦਨ ਸੰਸਕਰਣ ਬਣਾਓ
- npm run lint: ਕੋਡ ਜਾਂਚ
ਕੋਡਿੰਗ ਦਿਸ਼ਾ-ਨਿਰਦੇਸ਼
- ਕੰਪੋਨੈਂਟਸ ਲਈ ਫੰਕਸ਼ਨਲ ਲਿਖਤ ਦੀ ਵਰਤੋਂ ਕਰੋ
- ਸਟਾਈਲ ਲਈ Tailwind CSS ਦੀ ਵਰਤੋਂ ਕਰੋ
- ਹਰੇਕ ਕੰਪੋਨੈਂਟ ਨੂੰ ਇੱਕ ਵੱਖਰੇ ਫੋਲਡਰ ਵਿੱਚ ਰੱਖੋ`
ਛੋਟੀਆਂ ਗੱਲਾਂ
- ਇਸਨੂੰ ਸੰਖੇਪ ਰੱਖੋ: ਬਹੁਤ ਲੰਮਾ ਨਾ ਲਿਖੋ, AI ਵੀ "ਥੱਕ" ਜਾਵੇਗਾ
- ਨਿਯਮਿਤ ਤੌਰ 'ਤੇ ਅੱਪਡੇਟ ਕਰੋ: ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਬਦਲਾਵਾਂ ਹੋਣ 'ਤੇ CLAUDE.md ਨੂੰ ਅੱਪਡੇਟ ਕਰਨਾ ਯਾਦ ਰੱਖੋ
- ਉਦਾਹਰਣਾਂ ਨੂੰ ਤਰਜੀਹ ਦਿਓ: ਅਮੂਰਤ ਵਰਣਨ ਨਾਲੋਂ ਖਾਸ ਕੋਡ ਉਦਾਹਰਣਾਂ ਵਧੇਰੇ ਪ੍ਰਭਾਵਸ਼ਾਲੀ ਹੁੰਦੀਆਂ ਹਨ
- ਦਰਦ ਬਿੰਦੂਆਂ 'ਤੇ ਧਿਆਨ ਦਿਓ: ਉਹਨਾਂ ਖੇਤਰਾਂ 'ਤੇ ਧਿਆਨ ਕੇਂਦਰਿਤ ਕਰੋ ਜਿੱਥੇ ਗਲਤੀਆਂ ਹੋਣ ਦੀ ਸੰਭਾਵਨਾ ਹੈ
CLAUDE.md ਨੂੰ ਚੰਗੀ ਤਰ੍ਹਾਂ ਲਿਖੋ, ਅਤੇ AI ਨੂੰ ਆਪਣਾ ਕੀਮਤੀ ਸਹਾਇਕ ਬਣਾਓ!
