Is there a Best Practice document?

I’m learning RF and using AI to give me ideas. One of the things I’d like to do is give the AI an RF “Best Practices” document or URL so that I can learn things the right way and any code generated will follow the right way.

Suggestions?

Hi,

If you mean the way to write/code your test, you can provide robotidy/robocop link Robotidy 4.18.0

There are already here rules to apply to have a proper formatting (example: check the 4 spaces) but also functions/keywords build (example: not too many arguments).

Regards

Charlie

Hello,
I too, would strongly advise telling your AI to comply with RoboCop rules. Robotidy has actually been integrated into that tool and won’t be supported much further. In IDEs like Cursor, you can also just deploy the linting tool and have the agents fix the lint errors.

RoboCop actually complies with most (if not all) recommendations from the style guide.

There is also this old Dos And Donts slides, which is still valid on many points, though 11 year old sounds deprecated.

Maybe this should be included or already is in rf-prompt-forge?

Not sure either on how robotframework-MCP deals with the topic.

There’s also: GitHub - adrianyorke/robotframework-cookbook: A curated list of Robot Framework recipes to help beginner and intermediate engineers create test automation scripts faster. - maybe not exactly what OP is looking for but could give good pointers.

/me takes copious notes…

Thanks! This will help me learn the style myself and prompt better.

1 Like

Actually, @aaltat just released this robocop-mcp which might be even closer to what you need:

As a side note, this was advertised on the RobotFramework Slack if you want to join too.

2 Likes