Skip to content

Commit 70b8656

Browse files
authored
Add comment to .env (#309)
Checking in a `.env` file into git is not best practice. We have historically included this file in this template project to make our getting started guide easier for beginners to consume and currently we'd like to continue that ease of use. From discussions in #296 a reasonable alternative to removing the file would be to add a comment in the `.env` file (as this PR does) which explains why the file is in git and how to remove it. @fixes #47
1 parent bc4374f commit 70b8656

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

.env

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
# NOTE:
2+
# This .env file is checked into git for demonstration purposes only.
3+
# We recommend adding the `.env` file to your `.gitignore` file and
4+
# removing it from git cache with the command `git rm --cached .env`
15
TIMES=2

0 commit comments

Comments
 (0)