docs: clarify .env/.env.local convention#2158
Merged
Merged
Conversation
… accidental leaks
Keep .env tracked (Vite's convention: shared defaults, no secrets). Revert the rename, document the .env/.env.local split in the file header, .gitignore, and README.
Member
|
Thanks for the PR @abumoaz1! You're right that the previous docs didn't make the intent clear enough. This project follows Vite's I pushed a tweak in 59fb238 on top of your original commit (dfd7518) that reverts the rename but addresses the underlying concern by improving the documentation — clearer header in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
.env— rewrite header comment to state upfront that this file is committed with shared defaults only and secrets belong in.env.local.gitignore— add comment clarifying why.envis tracked while.env.localis ignoredREADME.md— expand "Configure Environment" section to document the.env/.env.localconvention with acp .env .env.localquick-start stepWhy
The
.envfile only contains placeholders (xxxxx,postgres://localhost, etc.) but the previous documentation didn't make this convention obvious, which could lead contributors to think secrets belong there. These changes make the intent clear at every touchpoint.Original PR description (outdated)