MarketSquare / MarketSquare/robotframework-faker

docs: add usage and example docs

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
69
Forks
23
PR merge metrics
No merged PRs in 30d

Description

it will be beneficial to have some general usage and examples documentation for this library (what is the provider, why does one find them, how does one add them?)
@emanlove FYI

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the issue description and inspect the repository's existing documentation structure to find the appropriate location for usage and examples. Document what the provider is, why users find providers, and how to add them; done means these topics are covered with usable examples.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.