sameersbn / sameersbn/docker-gitlab
Environment Variable Naming Inconsistency
Open
Nobody has claimed this yet.
wontfix
- Dominant language
- Shell
- Stars
- 8.1k
- Forks
- 2.1k
- Avg merge
- 17h 47m
- Merged PRs (30d)
- 7
Description
Some variables end in _DIR, others in _PATH. Mostly, _DIR points to a directory and _PATHto a file.
But there is SMTP_CA_PATH, which points to a directory. (I stopped checking after this).
Is there a policy for naming?
Sorry for this short description, but I'm in a hurry but wanted to document it somewhere.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named in the issue. First locate the environment-variable definitions for SMTP_CA_PATH and the other _DIR/_PATH variables, then determine the repository's naming policy; done means the policy and any agreed correction are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, shell
- Domain
- devops
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100