- Rule: separate code with newlines only to group together related logic
- Rule: separate code and block with newlines
- Newline after block
Newlines styleguide
This style guide recommends best practices for newlines in Ruby code.
Rule: separate code with newlines only to group together related logic
# bad
def method
issue = Issue.new
issue.save
render json: issue
end
# good
def method
issue = Issue.new
issue.save
render json: issue
end
Rule: separate code and block with newlines
Newline before block
# bad
def method
issue = Issue.new
if issue.save
render json: issue
end
end
# good
def method
issue = Issue.new
if issue.save
render json: issue
end
end
Newline after block
# bad
def method
if issue.save
issue.send_email
end
render json: issue
end
# good
def method
if issue.save
issue.send_email
end
render json: issue
end
Exception: no need for newline when code block starts or ends right inside another code block
# bad
def method
if issue
if issue.valid?
issue.save
end
end
end
# good
def method
if issue
if issue.valid?
issue.save
end
end
end
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc