stringio should be a stdlib, but it's in `core/`
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 256
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 37
Description
In Ruby, stringio is a stdlib.
https://github.com/ruby/ruby/tree/50520cc1930331bccdb94730e17ddc01798f2be0/ext/stringio
But currently, RBS has string_io as a core library unexpectedly.
https://github.com/ruby/rbs/blob/abcc97d3c8b024856ba9603a7ef22d422652ff42/core/string_io.rbs
So we should do the two things:
- Move string_io.rbs from
core/tostdlib/. - Rename it to
stringio.rbs- because the library name is
stringio.
- because the library name is
BTW, this will introduce a breaking change. We should do it carefully. For example, we can provide a migration process.
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
Start by reading core/string_io.rbs and comparing the referenced Ruby stringio library location with the stdlib layout. Determine how the signature should be moved and renamed to stdlib/stringio.rbs, then review how the breaking change and migration process should be documented. Done means the new location and library name are handled consistently without leaving the old core entry unexpectedly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100