MarketSquare / MarketSquare/robotframework-style-guide
Add rationale to rules
Open
Nobody has claimed this yet.
style-guide
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
As a reader I would like to know why a certain rule is being put forward so I can understand and reason with others about the choices we make on styling our code.
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
The issue does not name a file, rule, or test. Start by reviewing the style guide's existing rules and identify where rationale is documented; clarify which rules are in scope before making changes. Done means the agreed rules explain why they are recommended.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100