Galooshi/import-js

Improve CLI documentation

Open

#532 geöffnet am 31. Mai 2019

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (519 Stars) (70 Forks)batch import
help wanted

Beschreibung

I see docs here - https://github.com/Galooshi/import-js/#command-line-tool - that shows how to pass arguments to a given command but it doesn't say what the commands do. I've figured out that goto resolves the import statement to the file where its defined but the others remain a mystery. Just curious if we could get more explanation.

Contributor Guide

Tech Stack
javascript
Domain
documentationcli
Issue Type
documentation
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 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic understanding of import js CLI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
The issue requests better documentation for CLI commands. The existing docs are at https://github.com/Galooshi/import js/#command line tool. Investigate the source code to list all available commands (e.g., 'goto') and their functionality, then update the README with a description for each. Consider adding examples for common use cases.