rust-lang / rust-lang/rustup

Make it easier to add shells to shell.rs

Open
#2,449 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
22h 40m
Merged PRs (30d)
46

Description

We discussed and there was an understanding gap that has been bridged, in terms of smoothing out the code. The specific requests were in service of a goal I did not understand (and initially did not inquire too deeply about). As I now understand the higher-level goal (difficult-to-itemize improvements in clarity), I can draft some commits in service of that.

Originally posted by @workingjubilee in https://github.com/rust-lang/rustup/pull/2387#issuecomment-670327758

Documenting the issue here so I don't lose track of it before I open a new PR. Goal is to rework the helper fns in the module to be more generalized and composable where possible.

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.

Research direction

Start by locating shell.rs and reading its helper functions to understand how shells are currently added. The issue calls for clearer, more generalized and composable helpers, with completion shown by making future shell additions easier; no specific tests or validation command are named.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.