MarketSquare / MarketSquare/robotframework-style-guide
Add Dialects to code examples
Nobody has claimed this yet.
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
There are different ways of formatting things for different stakeholders. Some good discussions were had at the speakers corner on Robocon 2024 on this.
**Conclusion**: Add dialects
So far we have decided on two dialects (names need to be refined):
- Business Facing
- Developer Facing
Where business needs some way to make it as human readable as possible with the syntax at hand.
And developers need something they can relate to and which they can relate to their developed code.
Second sort of dialects can be:
- Testing
- Robotic Process Automation (RPA)
This has already been added, but I wanted to add it for completeness.
Rules and implementation on how to present it on the style guide still needs discussion and refinement.
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 style guide's existing code examples and the already-added Testing and RPA dialects. The issue still needs discussion and refinement of the dialect names, presentation rules, and implementation approach; done means those decisions are settled and the Business Facing and Developer Facing dialects are documented and applied.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100