MarketSquare / MarketSquare/robotframework-style-guide
Keyword Level Rules
Nobody has claimed this yet.
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
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 move to args or other keyword
- https://robocop.readthedocs.io/en/stable/rules_list.html#missing-doc-keyword-w0201
- https://robocop.readthedocs.io/en/stable/rules_list.html#wrong-case-in-keyword-name-w0302
- https://robocop.readthedocs.io/en/stable/rules_list.html#keyword-name-is-reserved-word-e0303
- https://robocop.readthedocs.io/en/stable/rules_list.html#underscore-in-keyword-name-w0305
- https://robocop.readthedocs.io/en/stable/rules_list.html#keyword-name-is-empty-e0312
- https://robocop.readthedocs.io/en/stable/rules_list.html#missing-keyword-name-e0403
- https://robocop.readthedocs.io/en/stable/rules_list.html#too-long-keyword-w0501
- https://robocop.readthedocs.io/en/stable/rules_list.html#too-few-calls-in-keyword-w0502
- https://robocop.readthedocs.io/en/stable/rules_list.html#too-many-calls-in-keyword-w0503
- Review Robocop and Robotidy for additional rules
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked Robocop rules and comparing the available Robotidy rules for keyword-level guidance. Define which rules should be covered, including limits on calls, loops, conditionals, data creation, naming, documentation, and keyword length. Done means the selected rules are clearly documented and additional relevant rules from both tools have been reviewed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100