jj-vcs/jj

docs: Add graph to more JJ command help

Open

#3,687 opened on May 14, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (1,052 forks)batch import
documentation 📖good first issue

Repository metrics

Stars
 (28,830 stars)
PR merge metrics
 (Avg merge 23d 5h) (46 merged PRs in 30d)

Description

Description

Several JJ commands already have graphs to help understand them when in their long --help form, this is awesome!

I would like all JJ command working with graph of more than a single revision to have at least one of those.

Steps to Reproduce the Problem

  1. jj interdiff --help <- no graph

Expected Behavior

The current list of commands is at https://martinvonz.github.io/jj/v0.17.1/cli-reference/ and we can for example see jj next has a graph. This should be the standard whenever possible/relevant, since words alone are often confusing/not enough when talking about graphs

Contributor guide

Research direction
Examine the source code for how the help graph for `jj next` is generated, likely in the command implementation. Identify the functions or modules that produce the graph. Then, for commands like `jj interdiff` that deal with multiple revisions, add a similar graph by following the same pattern. Check the existing CLI reference to ensure consistency.
Tech stack
rust
Domain
clidocumentation
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust programming basicsjj codebase familiarityunderstanding of existing graph examples
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70