Maintain consistent formatting and style choices throughout your codebase to improve readability and maintainability. This includes consistent variable syntax, proper quoting practices, and organized list formatting.
Key practices:
${VAR}
or don’t, but be consistent within the same file/project)Example of good formatting:
# Consistent variable quoting
docker build -f "${DOCKERFILE}" -t "${TAG}" --target "${DOCKER_BUILD_TARGET}" .
# Well-formatted package list
RUN pip install \
tox==2.1.1 \
virtualenv==16.2.0
Consistent formatting reduces cognitive load for code reviewers and makes diffs cleaner when modifications are needed.
Enter the URL of a public GitHub repository