Skip to content

कस्टम निर्देश

Repomix आपको अपने आउटपुट में कस्टम निर्देश शामिल करने की अनुमति देता है। ये निर्देश AI मॉडल को आपके कोडबेस के साथ कैसे इंटरैक्ट करना है, इसके बारे में मार्गदर्शन प्रदान करते हैं।

कस्टम निर्देश क्या हैं?

कस्टम निर्देश आपके कोडबेस के बारे में अतिरिक्त जानकारी या AI मॉडल के लिए विशिष्ट निर्देश हैं। इनका उपयोग निम्नलिखित के लिए किया जा सकता है:

  1. कोडबेस का संदर्भ प्रदान करना: प्रोजेक्ट संरचना, आर्किटेक्चर, या महत्वपूर्ण फाइलों के बारे में जानकारी
  2. विशिष्ट निर्देश देना: AI मॉडल को विशिष्ट कार्यों या विश्लेषण पर ध्यान केंद्रित करने के लिए निर्देश देना
  3. संदर्भ जोड़ना: प्रोजेक्ट के बारे में अतिरिक्त जानकारी या संदर्भ प्रदान करना

कस्टम निर्देश जोड़ना

कस्टम निर्देश जोड़ने के दो तरीके हैं:

1. कमांड लाइन विकल्प

--instructions विकल्प का उपयोग करके कस्टम निर्देश फाइल निर्दिष्ट करें:

bash
repomix --instructions ./instructions.md

2. कॉन्फिगरेशन फाइल

अपने repomix.config.json में instructions फील्ड का उपयोग करें:

json
{
  "instructions": "./instructions.md"
}

कस्टम निर्देश फॉर्मेट

कस्टम निर्देश फाइलें मार्कडाउन फॉर्मेट में होनी चाहिए। वे आपके आउटपुट फाइल के शीर्ष पर जोड़ी जाएंगी।

उदाहरण कस्टम निर्देश फाइल

markdown
# प्रोजेक्ट निर्देश

यह एक Node.js बैकएंड API है जो MongoDB का उपयोग करता है। प्रोजेक्ट की संरचना निम्नानुसार है:

- `src/controllers/`: API एंडपॉइंट हैंडलर्स
- `src/models/`: MongoDB मॉडल्स
- `src/services/`: बिजनेस लॉजिक
- `src/utils/`: उपयोगिता फंक्शन्स

## विश्लेषण के लिए निर्देश

कृपया निम्नलिखित पर ध्यान केंद्रित करें:

1. कोड गुणवत्ता और शैली
2. संभावित प्रदर्शन बॉटलनेक
3. सुरक्षा समस्याएं
4. त्रुटि हैंडलिंग

## महत्वपूर्ण नोट्स

- यह प्रोजेक्ट TypeScript का उपयोग करता है
- हम Express.js फ्रेमवर्क का उपयोग करते हैं
- हम Jest का उपयोग टेस्टिंग के लिए करते हैं

प्रभावी कस्टम निर्देश के लिए टिप्स

1. प्रोजेक्ट संदर्भ प्रदान करें

AI मॉडल को आपके प्रोजेक्ट के बारे में महत्वपूर्ण जानकारी प्रदान करें:

markdown
# प्रोजेक्ट संदर्भ

यह एक React फ्रंटएंड एप्लिकेशन है जो Redux का उपयोग स्टेट मैनेजमेंट के लिए करती है। 
हम Tailwind CSS का उपयोग स्टाइलिंग के लिए करते हैं।

2. विशिष्ट विश्लेषण क्षेत्र निर्दिष्ट करें

AI मॉडल को बताएं कि आप किन पहलुओं पर ध्यान केंद्रित करना चाहते हैं:

markdown
# विश्लेषण फोकस

कृपया निम्नलिखित पर ध्यान केंद्रित करें:
1. कंपोनेंट पुन: उपयोग और संरचना
2. प्रदर्शन अनुकूलन के अवसर
3. एक्सेसिबिलिटी समस्याएं

3. प्रोजेक्ट-विशिष्ट शब्दावली शामिल करें

महत्वपूर्ण शब्दावली या प्रोजेक्ट-विशिष्ट शब्दों को परिभाषित करें:

markdown
# प्रोजेक्ट शब्दावली

- **Workspace**: एक उपयोगकर्ता का निजी कार्य क्षेत्र
- **Collection**: संबंधित दस्तावेज़ों का एक समूह
- **Template**: पूर्व-परिभाषित दस्तावेज़ संरचना

4. कोडिंग मानक और दिशानिर्देश शामिल करें

अपने कोडिंग मानकों और दिशानिर्देशों को शामिल करें:

markdown
# कोडिंग मानक

- हम Airbnb JavaScript स्टाइल गाइड का पालन करते हैं
- सभी कंपोनेंट फंक्शनल कंपोनेंट होने चाहिए
- हम camelCase का उपयोग वेरिएबल और फंक्शन नामों के लिए करते हैं
- हम PascalCase का उपयोग कंपोनेंट नामों के लिए करते हैं

5. उदाहरण और संदर्भ शामिल करें

उदाहरण या संदर्भ शामिल करें जो AI मॉडल को मदद कर सकते हैं:

markdown
# उदाहरण और संदर्भ

## API एंडपॉइंट उदाहरण

```json
GET /api/users
{
  "users": [
    { "id": 1, "name": "John Doe" },
    { "id": 2, "name": "Jane Smith" }
  ]
}

डेटाबेस स्कीमा संदर्भ

User स्कीमा में निम्नलिखित फील्ड्स हैं:

  • id: UUID
  • name: String
  • email: String
  • createdAt: Date

## कस्टम निर्देशों के साथ आउटपुट

जब आप कस्टम निर्देशों के साथ Repomix का उपयोग करते हैं, तो आउटपुट फाइल में आपके निर्देश शीर्ष पर शामिल होंगे:

### XML आउटपुट

```xml
<!--
# प्रोजेक्ट निर्देश

यह एक Node.js बैकएंड API है...
-->

<repository>
  <file path="src/index.ts" type="typescript">
    // फाइल सामग्री
  </file>
  <!-- अन्य फाइलें -->
</repository>

मार्कडाउन आउटपुट

markdown
# प्रोजेक्ट निर्देश

यह एक Node.js बैकएंड API है...

---

# Repository

## src/index.ts
```typescript
// फाइल सामग्री

## अगला क्या है?

- [कमांड लाइन विकल्पों](command-line-options.md) के बारे में अधिक जानें
- [कॉन्फिगरेशन विकल्पों](configuration.md) का अन्वेषण करें
- [प्रॉम्प्ट उदाहरणों](prompt-examples.md) को देखें

Released under the MIT License.