Better usage examples
Open
Nobody has claimed this yet.
good first issue
help wanted
- Dominant language
- Rust
- Stars
- 250
- Forks
- 69
- PR merge metrics
- No merged PRs in 30d
Description
There are a lot of pieces to this that are uncovered in the example supplied in the docs. More examples would help to better show off how to use this
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 example supplied in the documentation and compare it with the pieces of usage the issue says are uncovered. Add examples that better show how to use the project, with completion indicated by broader coverage of its usage patterns.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100