robotframework-style-guide

robotframework-style-guide copied to clipboard

Rules to describe: - Max. number of KW calls in a KW - Number of FOR/WHILE loops - Number of IF/TRY - Data creation in Keywords: size of dicts, lists...

MiikkaSolmela

Commenting Robot Framework Code

2

- Inline comments - prefaced Comments- comments made before line of code - TODO comments - Suggested content for comments - Comments vs Documentation - Comments vs the Comments Section

kstine

Should we have guidance for format of an arguments file. Or should this be a guide not style guide?

kstine

Naming conventions

1

Rules to describe: - ~~... of (local vs. global) variables~~, KWs, TCs, tags, files (including extensions .robot vs. .resource) -Tags -Suite / Clobal > capital case - (Non-)allowed characters, naming...

MiikkaSolmela

RF Doc style Proposal

11

Keywords - Documentation (Proposed) Purpose: To leverage the VSCode Extension "Robot Framework Language Server" ability to preview Keyword Documentation. After reviewing a few docstring styles, the one that proved most...

kstine

Review Style Guide and Best Practices from VF

1

- [x] Upload Style Guide/Best Practices - [ ] Review - [ ] Discuss which parts can be re-used

manykarim

Mko13