Skip to content

Standardize .env/.env.example file handling across examples #1568

@Haleshot

Description

@Haleshot

This came up in #1470 — there's an inconsistency/ambiguity in how env files are handled across examples.

The current heuristic (as @badmonster0 explained) is: if an example contains XYZ_API_KEY, we provide a .env.example and expect users to copy it over to .env. Otherwise, we just use .env directly. This doesn't seem to be applied consistently; some examples document it:

# Copy this to .env and fill in your actual database connection string

...others don't.

I'm thinking we either standardize on .env.example everywhere (with clear comments like the above ^) or document a consistent pattern in a central place.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions