Skip to main content

Introduction And Basic Guide


This style guide is a community driven set of sensible rules to write your Robot Framework code.

As a starting point use the existing standards from Robot Framework user guide, Robocop and Robotidy.

Robocon 2022 Presentation


Guido Demmenie, Mannana Koberidze, Kelby Stine

Special Thanks To

Václav Fuksa, Many Kasiriha, Bartlomiej Hirsz, Mateusz Nojek, René Rohner, Miikka Solmela

We are always looking for contributors

  • If you have feedback please:
  • We meet up once every two weeks to talk about style guide topics

For more info go to our repository: MarketSquare/robotframework-style-guide

Basic Rules and Guidelines

Here are some good basic guidelines for formatting your Robot Framework code. As these are guidelines, use your best judgment in cases not covered by these recommendations.

  • Separate pieces of the data, such as keywords and their arguments, with four (4) spaces.
  • .robot and .resource file section order:
*** Comments ***    # Optionally the comments section can be placed at the bottom of the file.

*** Settings ***

*** Variables ***

*** Test Cases ***
*** Tasks ***

*** Keywords ***
  • Keywords within resource files should be alphabetized or organized by functionality or purpose. The important part is to organize keywords in a thoughtful manner.
  • The recommended minimum maximum line length is 120.
  • It is reasonable to split a variable definition across multiple lines when it exceeds the recommended line length, or for the better readability of the code. See Dividing data to several rows
  • Variable Syntax from the user guide variable-priorities-and-scopes
    • Global variables use upper-case letters.
    • Suite variables use upper-case letters.
    • Test variables use upper-case letters.
    • Local variables use lower-case letters.
    • Keyword arguments use lower-case letters.
  • Keywords should be capital cased. (i.e. This Keyword Is Capital Cased)

Version 0.5b