Variable and parameter names should be explicit about their purpose and consistent with established naming patterns in the codebase. Avoid ambiguous or generic names that could be confusing in context.
Make names explicit and descriptive:
versionActionsVersion instead of version when the context involves multiple version conceptstasksExecutionId or executionId instead of generic taskId when referring to execution identifiersgetAtomizedTaskEnvVars instead of getOutputEnvVars when the function has a specific scopeFollow established naming conventions:
releaseTagPatternStrictPreId not releaseTagPatternStrictPreid)is_golden not isGolden when other properties use underscores)Example:
// Avoid: Generic and potentially confusing
const taskId = hashArray([...process.argv, Date.now().toString()]);
const version = getVersion();
// Prefer: Explicit and descriptive
const tasksExecutionId = hashArray([...process.argv, Date.now().toString()]);
const versionActionsVersion = getVersionActionsVersion();
Enter the URL of a public GitHub repository