jj-vcs/jj

docs: Add graph to more JJ command help

Open

#3.687 geöffnet am 14. Mai 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (1.052 Forks)batch import
documentation 📖good first issue

Repository-Metriken

Stars
 (28.830 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 23T 5h) (46 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche den Quellcode, wie das Hilfediagramm für `jj next` erzeugt wird, wahrscheinlich in der Befehlsimplementierung. Identifiziere die Funktionen oder Module, die das Diagramm erzeugen. Füge dann für Befehle wie `jj interdiff`, die mehrere Revisionen behandeln, ein ähnliches Diagramm hinzu, indem du demselben Muster folgst. Überprüfe die vorhandene CLI Referenz, um Konsistenz sicherzustellen.
Tech Stack
rust
Domain
clidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust programming basicsjj codebase familiarityunderstanding of existing graph examples
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70