Правила використання заповнювачів для секретів

Використовуйте зрозумілі людині заповнювачі, які не схожі на справжні секрети.

Рекомендований стиль

• Надавайте перевагу описовим значенням, як-от 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}"