قراردادهای جانگهدار راز

از جانگهدارهایی استفاده کنید که برای انسان خوانا باشند، اما به رازهای واقعی شباهت نداشته باشند.

سبک پیشنهادی

• مقادیر توصیفی مانند 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}"