Clarify native-installation-instructions.md about Ruby installation

Open Beginner friendly
#2,379 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
ruby
Domain
documentation

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.

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
Dominant language
Ruby
Stars
104
Forks
205
Avg merge
1d 6h
Merged PRs (30d)
65

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from codebar/planner

All issues in codebar/planner

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.