Bash-it/bash-it

Add documentation for all commands

Offen

#1.680 geöffnet am 15.10.2020

Auf GitHub ansehenContributor Guide
 (10 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Shell (2.304 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (15.045 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 15T 22h) (1 gemergte PR in 30 T)

Beschreibung

I'm wondering whether we want to include this in the documentation. I've checked the main README file, it currently does not provide a complete list of all commands (e.g. bash-it reload). We might want to add that at one point - probably as a separate PR when (hopefully at one point) rework the documentation.

Originally posted by @nwinkler in https://github.com/Bash-it/bash-it/pull/1672#issuecomment-709528853

Contributor Guide

Research-Richtung
Überprüfe die vorhandene README und die Befehlsliste, um fehlende Befehle wie 'bash it reload' zu identifizieren. Erstelle dann eine Dokumentationsdatei oder aktualisiere die README entsprechend.
Tech Stack
shell
Domain
cli
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitShell
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80