Write code that prioritizes readability and clarity over brevity. Use proper formatting, clear expressions, and consistent patterns to make code easier to understand and maintain.
Write code that prioritizes readability and clarity over brevity. Use proper formatting, clear expressions, and consistent patterns to make code easier to understand and maintain.
Key practices:
('Updated state to
%s in
%s'):format(version_str, name)
instead of 'Updated state to
’ .. version_str .. ‘ in
’ .. name .. ‘'
(metadata.conceal ~= nil) and metadata.conceal or (metadata[capture] and metadata[capture].conceal)
instead of metadata.conceal ~= nil and metadata.conceal or metadata[capture] and metadata[capture].conceal
if status then
instead of if status == true then
local version_str = resolve_version()
and local version_ref = get_reference()
instead of local version_str, version_ref = resolve_version(), get_reference()
The goal is to write code that another developer can quickly understand without having to parse complex expressions or guess at intentions.
Enter the URL of a public GitHub repository