Skip to content
Apothem
संदर्भ

नामकरण परंपराएँ

kebab-case फ़ाइल नाम, frontmatter कुंजी प्रारूप, टाइप उपसर्गों के साथ ब्रांच नामकरण, और क्रमबद्ध आर्टिफ़ैक्ट अनुक्रमों के लिए संख्यात्मक उपसर्ग शब्दार्थ निर्धारित करता है।

पूरे पारिस्थितिकी तंत्र में फ़ाइल नाम, पहचानकर्ता और ब्रांच नाम के स्वरूप के लिए विहित संदर्भ। CLAUDE.md परंपराओं में दिया गया सारांश इनलाइन घोषणा है; यह पृष्ठ वह स्वतंत्र संदर्भ है जिसे डाउनस्ट्रीम योगदानकर्ता उद्धृत करते हैं।


1. फ़ाइल सिस्टम नाम

फ़ाइलें और फ़ोल्डर डिफ़ॉल्ट रूप से kebab-case का उपयोग करते हैं। पहचानकर्ताओं में कोई रिक्त स्थान, कोई अंडरस्कोर, और कोई कैमल-केस नहीं होता।

विहित अपरकेस अपवाद उन प्रकाशन-सतह सिंगलटन फ़ाइलों के लिए आरक्षित हैं जिन्हें हर योगदानकर्ता पहली ही मुठभेड़ में पहचान लेता है: CLAUDE.md, README.md, LICENSE, CHANGELOG.md, SECURITY.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, और योजना-सूट सिंगलटन (MASTER-PLAN.md, PROGRESS.md, PHASE.md, SKILL.md, VERSION)। बाकी हर फ़ाइल kebab-case का उपयोग करती है।

2. frontmatter कुंजियाँ

YAML frontmatter कुंजियाँ kebab-case का उपयोग करती हैं (उदाहरण के लिए, argument-hint, disable-model-invocation)। kebab-case नियम नियमों, कमांडों, प्रत्यायोजित कार्यकर्ताओं, कौशलों, और स्वयं CLAUDE.md में एकसमान रूप से लागू होता है।

3. ब्रांच नाम

ब्रांच <type>/<short-description> का अनुसरण करते हैं, जहाँ टाइप बंद समुच्चय {feat, fix, chore, docs, refactor, test, perf, ci, build, style, revert, release} से लिया जाता है। विवरण kebab-case में और पचास वर्णों से कम होता है।

4. संख्यात्मक उपसर्ग

फ़ाइल सिस्टम पथों पर संख्यात्मक उपसर्ग (NN-) क्रम का संप्रेषण करते हैं और केवल वहीं लागू होते हैं जहाँ क्रम अंतर्निहित है — चरण फ़ोल्डर, उप-चरण फ़ोल्डर, माइग्रेशन स्क्रिप्ट, और कोई भी अन्य आर्टिफ़ैक्ट वर्ग जिसका अनुक्रम अनुबंध का हिस्सा है। जिन रूट-स्तरीय सिंगलटन के पास कोई सहोदर अनुक्रम नहीं है, वे कोई संख्यात्मक उपसर्ग नहीं लेते; उपसर्ग जोड़ना एक ऐसे क्रम संबंध का गलत संकेत देता है जो मौजूद नहीं है। पूर्ण अनुशासन src/apothem/rules/canonical-layout.md §2.1 में रहता है।

5. सत्यापनकर्ता

src/apothem/conformity/naming_grep.py पर naming-grep यांत्रिक प्रवर्तन सतह है। CI इसे make validate के माध्यम से आह्वान करता है।

On this page