Skip to content

Commit

Permalink
Add node on environment variable names
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyakaznacheev committed Feb 19, 2023
2 parents 86413df + 86971f1 commit aea2c89
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
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

0 comments on commit aea2c89

Please sign in to comment.