MarketSquare / MarketSquare/robotframework-style-guide
Naming conventions
Nobody has claimed this yet.
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
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 conventions like snake case, camel case etc.
- Semantic rules, e.g.
- Boolean variables starts with a verb: is_, does_, has_, ...
- KW are in imperative mood
- Length of names
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 with issue #12 and inventory the listed naming topics: variables, keywords, test cases, tags, files, suites, allowed characters, semantic rules, and name length. Determine where these rules belong in the style guide, then document the agreed conventions and examples for each category.
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
- 30/100