provide readme with some basic examples
Open
- Dominant language
- Go
- Stars
- 127
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Hi, I noticed that there isnt a readme in this repo. I am unsure how to test the package.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the Go package and its existing testing setup to determine how it is tested and what basic usage should be demonstrated. Add a README with basic examples and testing instructions; done means a newcomer can understand how to use and test the package.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100