spr

SPR ·

Un outil de ligne de commande pour soumettre et mettre à jour les demandes GitHub Pull de Git Commits local qui peuvent être modifiés et rediffoncés. Les demandes de traction peuvent être empilées pour permettre une série de revues de code du code interdépendant.

SPR est prononcé / ˈsuːpəɹ /, comme le mot anglais «super».

Documentation

Une documentation complète est disponible ici: https://spacedentist.github.io/spr/

Installation

Installation binaire

Utilisation de Homebrew

brew install spr

Utilisation de Nix

nix-channel --update && nix-env -i spr

Utilisation de la cargaison

Si vous avez des cargaisons installées (l'outil de construction de rouille), vous pouvez installer SPR en fonctionnant

cargo install spr

Installer à partir de la source

SPR est écrit en rouille. Vous avez besoin d'une chaîne d'outils de rouille pour construire à partir de la source. Voir rustup.rs pour plus d'informations sur la façon d'installer Rust si vous n'avez pas déjà de chaîne d'outils de rouille sur votre système.

Avec Rust All Configuration, clonez ce référentiel et exécutez cargo build --release . Le binaire SPR sera dans le répertoire target/release .

Start

Pour utiliser SPR, exécutez spr init dans une caisse locale d'un référentiel Git soutenu par GitHub. On vous demandera un GitHub Pat (Token d'accès personnel), que SPR utilisera pour passer des appels à l'API GitHub afin de créer et de fusionner les demandes de traction.

Pour soumettre un commit pour la demande de traction, exécutez spr diff .

Si vous souhaitez apporter des modifications à la demande de traction, modifiez votre engagement local (et / ou réprimande) et appelez à nouveau spr diff . Lors de la mise à jour d'une demande de traction existante, SPR vous demandera un court message pour décrire la mise à jour.

Pour Squash-Merge une demande de traction ouverte, exécutez spr land .

Pour plus d'informations sur les commandes et les options SPR, exécutez spr help . Pour plus d'informations sur une commande SPR spécifique, exécutez spr help <COMMAND> (par exemple spr help diff ).

Contributif

N'hésitez pas à soumettre un problème sur GitHub si vous avez trouvé un problème. Si vous pouvez même fournir un correctif, veuillez soulever une demande de traction!

S'il y a des changements ou des fonctionnalités plus importants sur lesquels vous souhaitez travailler, veuillez d'abord soulever un problème sur GitHub pour discuter.

Licence

SPR est sous licence MIT.