approvals / approvals/ApprovalTests.Ruby
Update readme
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 231
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
I was browsing around the code and am amazed at the amount of functionality which I didn't see from the readme. I think it would be really worthwhile to update the readme with the functionality at least, even if it isn't very well written/with lots of examples for now. I really think this is a great gem, and it apparantly is even better than I thought :)
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 reading the repository's README and surveying the Ruby gem's functionality in the code. Update the README to cover the functionality that is currently missing, with examples where practical; done means the README gives newcomers a substantially clearer overview of the gem.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100