bazelbuild/bazel

Command line completion documentation is incomplete

Open

#16,651 opened on Nov 3, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P2help wantedteam-Documentationteam-OSStype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

There is some documentation of command line completion, focused on how to install it. To my surprise, it doesn't discuss what I assume to be the most common scenario, i.e. bazel installed via bazelisk. (I assume you need to follow the bootstrapping instructions in this case, but it's far from obvious!)

It would be great if the documentation explicitly discussed how to enable completion when bazel is installed using bazelisk.

Contributor guide

Research direction
Investigate how bazelisk handles shell completion and write documentation outlining installation steps for common shells (bash, zsh). Include commands to enable completion and verify it works.
Tech stack
None
Domain
clibuild system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75