jj-vcs/jj

docs: Add graph to more JJ command help

Open

#3 687 ouverte le 14 mai 2024

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Rust (1 052 forks)batch import
documentation 📖good first issue

Métriques du dépôt

Stars
 (28 830 stars)
Métriques de merge PR
 (Merge moyen 23j 5h) (46 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez le code source pour comprendre comment le graphique d'aide pour `jj next` est généré, probablement dans l'implémentation de la commande. Identifiez les fonctions ou modules qui produisent le graphique. Ensuite, pour des commandes comme `jj interdiff` qui traitent plusieurs révisions, ajoutez un graphique similaire en suivant le même modèle. Vérifiez la référence CLI existante pour assurer la cohérence.
Stack technique
rust
Domaine
clidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust programming basicsjj codebase familiarityunderstanding of existing graph examples
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70