Clarify native-installation-instructions.md about Ruby installation
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 104
- Forks
- 205
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 63
Description
Description of the issue 📄
This is a wording improvement request.
native-installation-instructions.md mentions lots of literal version numbers such as "3.4.7" - but the tools involved read that file (.ruby-version)for a specific value.
Steps to fix 🛠
- Check that rvm and rbenv both can install directly using some version-implicit command (rvm install rather than rvm install 3.4.7).
- Clarify the text file
To do 📋
- Claim this issue (comment below, or assign yourself if you are part of the codebar org)
- Fork and clone the repository
- Update the relevant files. Follow the steps to fix section in this issue.
- Commit your changes as one commit. Use the title of this issue as your commit message
- Submit a pull request
- Mention this issue in the PR description by including it's number
- Have your pull request reviewed & merged by a codebar team member
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 with native-installation-instructions.md and review the Ruby installation steps, especially the references to literal versions such as 3.4.7. Check whether rvm and rbenv support the version-implicit commands described in the issue. Done means the instructions accurately explain how the tools read the repository's .ruby-version file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100