MarketSquare / MarketSquare/robotframework-style-guide
Commenting Robot Framework Code
Open
Nobody has claimed this yet.
style-guide
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
- Inline comments
- prefaced Comments- comments made before line of code
- TODO comments
- Suggested content for comments
- Comments vs Documentation
- Comments vs the Comments Section
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 existing Robot Framework Style Guide and the topics listed in this issue: inline, prefaced, and TODO comments, plus suggested comment content. Define the guidance for comments versus documentation and the Comments Section, then ensure all listed topics are covered in the guide.
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
- Mostly clear
- Newbie friendliness
- 35/100