-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Open
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Description
We have lots of instances of this pattern:
"{{ some_var | d(some_default_value) }}"
Where the same value is repeated multiples places in the code base
-> that default should be defined only once.
We should instead define those defaults in roles defaults/ directories, either
- in the role where it's used
- in kubespray-defaults (main.yml) if it's used in several roles.
Where possible, the default definition should also be accompanied by a comment defining the use of the variable, and possibly a commented examples for variable with a complex internal structure.
The two benefits:
- the code is more readable when not littered with
defaultfilters - variables are defined in one place
(by the way, this also apply to variable which we check with is defined -> we shouldn't have to do that if we define a default)
There is no need to tackle every instance at once, but this is pretty good way to start working on the code base for new contributors.
/help
/good-first-issue
Metadata
Metadata
Assignees
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.