Link to "The State of Ruby 3 Typing" in the README
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 256
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 37
Description
I arrived at this repository via the Ruby 3.0.0 Preview 1 Released blog post.
The README didn't immediately make it clear to me how this might be integrated into a Ruby developer's workflow. After a bit of Googling I came across this excellent blog post, The State of Ruby 3 Typing , which explains the high level purpose of this gem and how it intends to fit into the ecosystem.
I wonder if you'd consider linking to that blog post in the README to make it easier for future visitors to understand the high level goals of the project?
Or perhaps incorporate some parts of the blog post into an expanded version of the README to give more context to the problem this (excellent!) gem is solving.
Thank you for all your hard work on this project ✨
Contributor guide
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
Open the README and compare its current project context with the linked “The State of Ruby 3 Typing” article. Add a link to the article, or incorporate relevant high-level context as the maintainers prefer. Done means the README gives visitors clearer guidance on the gem’s goals and Ruby developer workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100