Konventionen für Secret-Platzhalter

Verwenden Sie Platzhalter, die für Menschen lesbar sind, aber nicht wie echte Secrets aussehen.

Empfohlener Stil

• Bevorzugen Sie aussagekräftige Werte wie example-openai-key-not-real oder example-discord-bot-token.
• Bevorzugen Sie in Shell-Codeausschnitten ${OPENAI_API_KEY} gegenüber direkt eingefügten tokenähnlichen Zeichenfolgen.
• Gestalten Sie Beispiele eindeutig als Fälschungen und stimmen Sie sie auf den jeweiligen Zweck ab (Provider, Kanal, Authentifizierungstyp).

Vermeiden Sie diese Muster in der Dokumentation

• Wörtliche Kopf- oder Fußzeilentexte privater PEM-Schlüssel.
• Präfixe, die echten Zugangsdaten ähneln, z. B. sk-..., xoxb-..., AKIA....
• Realistisch aussehende Bearer-Tokens, die aus Laufzeitprotokollen kopiert wurden.

Beispiel

# Gutexport OPENAI_API_KEY="example-openai-key-not-real" # Besser (wenn es in der Dokumentation um die Einbindung von Umgebungsvariablen geht)export OPENAI_API_KEY="${OPENAI_API_KEY}"