Skip to content

Create ENV_EXAMPLE_NOTES.md #39072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
JonesRoy3 wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Draft

Create ENV_EXAMPLE_NOTES.md #39072

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/ENV_EXAMPLE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Environment example notes

When updating `.env.example` (or similar templates):

- Keep placeholders obvious (e.g., `YOUR_API_KEY_HERE`)
- Never include real keys, tokens, or private endpoints
- Group variables by feature area
- Add brief inline comments for non-obvious fields

If you introduce a new required variable, document:
- where it is used
- acceptable values
- safe default (if any)
Loading