​

Konwencje dotyczące symboli zastępczych sekretów

​

Zalecany styl

• Preferuj opisowe wartości, takie jak example-openai-key-not-real lub example-discord-bot-token.
• We fragmentach skryptów powłoki preferuj ${OPENAI_API_KEY} zamiast ciągów wpisanych bezpośrednio i przypominających tokeny.
• Zadbaj, aby przykłady były jednoznacznie fikcyjne i dopasowane do celu (dostawcy, kanału, typu uwierzytelniania).

​

W dokumentacji unikaj następujących wzorców

• Dosłownego tekstu nagłówka lub stopki klucza prywatnego PEM.
• Prefiksów przypominających aktywne dane uwierzytelniające, np. sk-..., xoxb-..., AKIA....
• Realistycznie wyglądających tokenów okaziciela skopiowanych z dzienników środowiska uruchomieniowego.

​

Przykład

# Dobrze
export OPENAI_API_KEY="example-openai-key-not-real"

# Lepiej (gdy dokumentacja dotyczy konfiguracji zmiennych środowiskowych)
export OPENAI_API_KEY="${OPENAI_API_KEY}"