Konventionen für Geheimnis-Platzhalter

Verwenden Sie Platzhalter, die für Menschen lesbar sind, aber echten Geheimnissen nicht ähneln.

Empfohlener Stil

• Bevorzugen Sie beschreibende Werte wie example-openai-key-not-real oder example-discord-bot-token.
• Bevorzugen Sie für Shell-Ausschnitte ${OPENAI_API_KEY} gegenüber eingebetteten Token-ähnlichen Zeichenfolgen.
• Gestalten Sie Beispiele eindeutig als unecht und beschränken Sie sie auf ihren Zweck (Provider, Kanal, Authentifizierungstyp).

Diese Muster in der Dokumentation vermeiden

• Wörtlicher Kopf- oder Fußzeilentext eines privaten PEM-Schlüssels.
• Präfixe, die echten Anmeldedaten ähneln, z. B. sk-..., xoxb-..., AKIA....
• Realistisch wirkende Bearer-Token, 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}"