Bash-it/bash-it

Add documentation for all commands

Open

#1680 aperta il 15 ott 2020

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)Shell (2304 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (15.045 star)
Metriche merge PR
 (Merge medio 4g 17h) (2 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina l'attuale README.md e qualsiasi file di documentazione nel repository per identificare quali comandi sono già documentati. Controlla i file di definizione dei comandi (ad es. in plugins, aliases o lib) per elencare tutti i comandi disponibili. Il problema specifica che manca 'bash it reload'. L'obiettivo è creare un elenco completo e aggiungerlo alla documentazione.
Tech stack
shell
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Knowledge of Bash it commandsFamiliarity with MarkdownAccess to Bash it source code
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70