Skip to content
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

Jump to bottom

Add node on environment variable names #114

Merged
merged 1 commit into from
Feb 19, 2023
Merged

Add node on environment variable names #114

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ We prioritize clear and easy-to-understand code over complex or "magical" soluti
If you're considering making a code change that might be considered overcomplicated or not in line with the project's goals,
we recommend opening an issue to discuss the change before submitting a pull request.

#### Note on environment variables names

Cleanenv strives to be as explicit and as obvious as possible, and as such,
we decided to write environment variable in config struct tags *as is*.
It was done for purpose. This decision guarantees that programmer can *always* find environment variable by its name in code.
It may not sound pretty useful for such a limitation, but in my own experience, it is.
So you always will be able to find environment variable by its whole name in code,
which makes writing complex nested config structures a bit more difficult.

By the same reason, any contribution changing this behavior will be rejected.
Please not add any prefixes or suffixes to environment variables names, we will just not approve such PRs.
Thanks for understanding.

### Reporting Bugs and Requesting Features

If you've found a bug or have an idea for a new feature, please open an issue on our GitHub repository. Be sure to include as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior.
Expand Down