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

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

سبک توصیه‌شده

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