Get started
Konvensi Placeholder Rahasia
Konvensi placeholder rahasia
Gunakan placeholder yang mudah dibaca manusia tetapi tidak menyerupai rahasia sungguhan.
Gaya yang disarankan
- Utamakan nilai deskriptif seperti
example-openai-key-not-realatauexample-discord-bot-token. - Untuk cuplikan shell, utamakan
${OPENAI_API_KEY}daripada string inline yang menyerupai token. - Pastikan contoh jelas palsu dan dibatasi sesuai tujuan (penyedia, saluran, jenis autentikasi).
Hindari pola ini dalam dokumentasi
- Teks header atau footer kunci privat PEM literal.
- Prefiks yang menyerupai kredensial aktif, misalnya
sk-...,xoxb-...,AKIA.... - Token bearer yang tampak realistis dan disalin dari log runtime.
Contoh
# Goodexport OPENAI_API_KEY="example-openai-key-not-real" # Better (when the doc is about env wiring)export OPENAI_API_KEY="${OPENAI_API_KEY}"Was this useful?