गुप्त जानकारी के प्लेसहोल्डर संबंधी परंपराएँ

ऐसे प्लेसहोल्डर का उपयोग करें जो मानव-पठनीय हों, लेकिन वास्तविक गुप्त जानकारी जैसे न दिखें।

अनुशंसित शैली

• example-openai-key-not-real या example-discord-bot-token जैसे वर्णनात्मक मानों को प्राथमिकता दें।
• शेल स्निपेट के लिए, इनलाइन टोकन-जैसी स्ट्रिंग के बजाय ${OPENAI_API_KEY} को प्राथमिकता दें।
• उदाहरणों को स्पष्ट रूप से काल्पनिक और उद्देश्य (प्रदाता, चैनल, प्रमाणीकरण प्रकार) तक सीमित रखें।

दस्तावेज़ों में इन पैटर्न से बचें

• शाब्दिक PEM निजी-कुंजी हेडर या फुटर टेक्स्ट।
• ऐसे प्रीफ़िक्स जो सक्रिय क्रेडेंशियल जैसे दिखें, उदाहरण के लिए sk-..., xoxb-..., AKIA...।
• रनटाइम लॉग से कॉपी किए गए वास्तविक दिखने वाले बेयरर टोकन।

उदाहरण

# अच्छाexport OPENAI_API_KEY="example-openai-key-not-real" # बेहतर (जब दस्तावेज़ एनवायरनमेंट वेरिएबल की वायरिंग के बारे में हो)export OPENAI_API_KEY="${OPENAI_API_KEY}"