Choose names that are self-explanatory, descriptive, and consistent across the codebase. Avoid abbreviated or informal naming that requires additional explanation. Follow language-specific conventions and include units or data types where appropriate.
Choose names that are self-explanatory, descriptive, and consistent across the codebase. Avoid abbreviated or informal naming that requires additional explanation. Follow language-specific conventions and include units or data types where appropriate.
Key principles:
maximum-runtime
instead of runsec-max
)ReserveNodesMap
instead of nodeForbidMap
)maxRetry
consistently rather than mixing jobRetry
and maxRetry
)500s
instead of just 500
)reserveable: true
instead of is-reserve: 1
)Example improvements:
# Before - informal and unclear
volcano.sh/is-reserve: 1
volcano.sh/runsec-max: 500
# After - descriptive and clear
volcano.sh/reserveable: true
volcano.sh/maximum-runtime: 500s
// Before - requires explanation
nodeForbidMap map[string]bool
jobRetry int
// After - self-explanatory and consistent
ReserveNodesMap map[string]bool
maxRetry int
Enter the URL of a public GitHub repository